Changeset 6942

Timestamp:

2004-03-05T16:24:30+13:00 (20 years ago)

Author:

kjdon

Message:

tidied up List classifier: now takes comma separated list for -metadata, -sort can be nosort

File:

• trunk/gsdl/perllib/classify/List.pm (modified) (9 diffs)

trunk/gsdl/perllib/classify/List.pm

@@ -25 +25 @@
 
 # simple list classifier plugin 
-# options are:
-# metadata=Metaname -- (optional) all documents with Metaname metadata
-#                      will be included in list. if not included all documents
-#                      will be included in list.
-# sort=Meta         -- (optional) sort documents in list alphabetically by
-#                      Meta. by default it will sort by Metaname, if neither
-#                      are set documents will be in build (random) order.
-#                      Meta may be Filename to sort by original filename or
-#                      nosort to force not to sort
-# buttonname=Title  -- (optional) the title field for this classification.
-#                      if not included title field will be Metaname. 
-#                      if metadata is also not included title will be 'List'
-
-# 12/05/02 Added usage datastructure - John Thompson
+# to see the options, run "perl -S classinfo.pl List"
 
 use BasClas;
@@ -53 +40 @@
     'desc' => "{List.metadata}",
     'type' => "metadata",
-    'reqd' => "yes" },
+    'reqd' => "no" },
       { 'name' => "buttonname",
     'desc' => "{List.buttonname}",
@@ -71 +58 @@
         'args'     => $arguments };
 
-#  sub print_usage {
-#      print STDERR "
-#    usage: classify List [options]
-#    options:
-
-#     -metadata X    Metadata field used for classification,
-#                    list will be sorted by this element.
-
-#     -buttonname X  (optional) Title field for this classification.
-#                    if not included title field will be Metaname. 
-
-#     -sort X        (optional) Sort documents in list by this metadata field.
-#                    By default it will sort by Metaname, or (if this is not
-#                    set) in build (random) order.
-#  ";
-#  }
 
 sub new {
@@ -96 +67 @@
     push( @{$option_list}, $options );
 
-    my ($metaname, $title, $sortname, $list);
+    my ($metadata, $title, $sortname, $list);
 
     if (!parsargv::parse(\@_, 
-             q^metadata/.*/^, \$metaname,
+             q^metadata/.*/^, \$metadata,
              q^buttonname/.*/^, \$title,
              q^sort/.*/^, \$sortname,
@@ -108 +79 @@
     die "\n";
     }
+    my @meta_list;
+    my $meta1;
+    
+    if ($metadata) {
+    @meta_list = split(/,/, $metadata);
+    $meta1 = $meta_list[0];
+    } else {
+    $metadata = undef;
+    $meta1=undef;
+    @meta_list = undef;
+    }
 
     if (!$title) {
-    if ($metaname) {
-        $title = $metaname;
+    if (defined ($meta1)) {
+        $title = $meta1;
     } else {
         $title = 'List';
@@ -117 +99 @@
     }
 
+    # sortname is handled a bit differently - kjdon
+    # undef means to sort, but use the metadata value from -metadata
+    # because there is no one metadata value to get for sorting when 
+    # we have a list of possible metadata
+    # to get no sorting, set sortname = 'nosort'
     if (!$sortname) {
-    if ($metaname) {
-        $sortname = $metaname;
-    } else {
+    if (defined ($metadata)) {
         $sortname = undef;
-    }
-    }
-
-    if ($metaname) {
+    } else {
+        $sortname = "nosort";
+    }
+    }
+    
+    if (defined $sortname && $sortname eq "nosort") {
+    $list = [];
+    } else {
     $list = {};
-    } else {
-    $list = [];
-    $metaname = undef;
-    }
-
+    }
+    
     $self->{'list'} = $list;
-    $self->{'metaname'} = $metaname;
+    if (defined $metadata) {
+    $self->{'meta_list'} = \@meta_list;
+    }
     $self->{'title'} = $title;
     $self->{'sortname'} = $sortname;
@@ -143 +131 @@
     my $self = shift (@_);
 
-    if (defined $self->{'sortname'}) {
-    $self->{'list'} = {};
-    } else {
-    $self->{'list'} = [];
-    }
 }
 
@@ -156 +139 @@
     my $doc_OID = $doc_obj->get_OID();
 
-    my $sortmeta = "";
+    # are we sorting the list??
+    my $nosort = 0;
+    if (defined $self->{'sortname'} && $self->{'sortname'} eq "nosort") {
+    $nosort = 1;
+    }
+    
+    my $metavalue;
+    my $metaname;
+    if (defined $self->{'meta_list'}) {
+    # find the first available metadata
+    foreach $m (@{$self->{'meta_list'}}) {
+        $metavalue = $doc_obj->get_metadata_element($doc_obj->get_top_section(), $m);
+        $metaname = $m;
+        last if defined $metavalue;
+    } 
+    #if we haven't found a metavalue here, then the doc shouldn't be included
+    return unless defined $metavalue;
+    }
+    
+    # we know the doc should be included, add it now if we are not sorting
+    if ($nosort) {
+    push (@{$self->{'list'}}, $doc_OID);
+    return;
+    }
+
+    #check for a sort element other than our metadata
     if (defined $self->{'sortname'}) {
+    my $sortmeta;
     if ($self->{'sortname'} =~ /^filename$/i) {
         $sortmeta = $doc_obj->get_source_filename();
     } else {
-        $sortmeta = $doc_obj->get_metadata_element($doc_obj->get_top_section(),
-                               $self->{'sortname'});
+        $sortmeta = $doc_obj->get_metadata_element($doc_obj->get_top_section(), $self->{'sortname'});
         if (defined $sortmeta) {
-        
-        my $lang = $doc_obj->get_metadata_element ($doc_obj->get_top_section(), 'Language');
-        $lang = 'en' unless defined $lang;
-        if ($lang eq 'en') {
-            if ($self->{'sortname'} eq "Creator") {
-            &sorttools::format_string_name_english (\$sortmeta);
-            } else {
-            &sorttools::format_string_english (\$sortmeta);
-            }
-        }
+        $sortmeta = &format_sort_meta($self->{'sortname'}, $sortmeta, $doc_obj);
         }
     }
     $sortmeta = "" unless defined $sortmeta;
-
-    if (defined $self->{'metaname'}) {
-        my $metavalue = $doc_obj->get_metadata_element ($doc_obj->get_top_section(),
-                                $self->{'metaname'});
-        if (defined $metavalue) {
-        if (defined $self->{'list'}->{$doc_OID}) {
-            my $outhandle = $self->{'outhandle'};
-            print $outhandle "WARNING: List::classify called multiple times for $doc_OID\n";
-        } 
-        $self->{'list'}->{$doc_OID} = $sortmeta;
-        }
-    } else {
-        if (defined $self->{'list'}->{$doc_OID}) {
-        my $outhandle = $self->{'outhandle'};
-        print $outhandle "WARNING: List::classify called multiple times for $doc_OID\n";
-        } 
-        $self->{'list'}->{$doc_OID} = $sortmeta;
-    }
-    } else {
-    if (defined $self->{'metaname'}) {
-        my $metavalue = $doc_obj->get_metadata_element ($doc_obj->get_top_section(),
-                                $self->{'metaname'});
-        if (defined $metavalue) {
-        push (@{$self->{'list'}}, $doc_OID);
-        }
-    } else {
-        push (@{$self->{'list'}}, $doc_OID);
-    }               
-    }
+    $self->{'list'}->{$doc_OID} = $sortmeta;
+    } else {
+    # we add to the list based on metadata value
+    # but we need to do the same formatting as for sort value
+    ($metavalue) = &format_sort_meta($metaname, $metavalue, $doc_obj);
+    $self->{'list'}->{$doc_OID} = $metavalue;
+    }
+}
+
+sub format_sort_meta {
+    my ($sortname, $sortvalue, $doc_obj) = @_;
+    
+    my $lang = $doc_obj->get_metadata_element ($doc_obj->get_top_section(), 'Language');
+    $lang = 'en' unless defined $lang;
+    if ($lang eq 'en') {
+    if ($sortname eq "Creator") {
+        &sorttools::format_string_name_english (\$sortvalue);
+    } else {
+        &sorttools::format_string_english (\$sortvalue);
+    }
+    }
+    return $sortvalue;
 }
 
@@ -214 +206 @@
 
     my @list = ();
-    if (defined $self->{'sortname'}) {
+    if (defined $self->{'sortname'} && $self->{'sortname'} eq "nosort") {
+    @list = @{$self->{'list'}};
+    } else {
     if (keys %{$self->{'list'}}) {
         @list = sort {$self->{'list'}->{$a} 
               cmp $self->{'list'}->{$b};} keys %{$self->{'list'}};
-    }
-    } else {
-    @list = @{$self->{'list'}};
+    }   
     }