Changeset 6970

Timestamp:

2004-03-08T16:27:43+13:00 (20 years ago)

Author:

kjdon

Message:

rewrote this so it handles a comma separated list of metadata. this was really old, and seemed to have a -section option - maybe this should be added back in as a proper option to the classifier?

File:

• trunk/gsdl/perllib/classify/SectionList.pm (modified) (4 diffs)

trunk/gsdl/perllib/classify/SectionList.pm

@@ -44 +44 @@
         'inherits' => "yes" };
 
-#  sub print_usage {
-#      print STDERR "
-#    usage: classify SectionList [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.
-
-#  Same as List classifier but includes all sections of document
-#  (excluding top level) rather than just top level document.
-#  ";
-#  }
 
 sub new {
@@ -72 +53 @@
     push( @{$option_list}, $options );
 
+    #if ($self->{'info_only'}) {
+    # created from classinfo.pl - don't need to parse the arguments
+    #   return bless $self, $class;
+    #}
     return bless $self, $class;
 }
@@ -77 +62 @@
 sub classify {
     my $self = shift (@_);
-    my ($doc_obj, @options) = @_;
+    my ($doc_obj) = @_;
     
-    my $thissection = undef;
-
-    my $option;
-    foreach $option (@options)
-    {
-    if ($option =~ m/^section=(\d+)$/i) 
-    {
-        $thissection = $1;
-    }
+    # are we sorting the list??
+    my $nosort = 0;
+    if (defined $self->{'sortname'} && $self->{'sortname'} eq "nosort") {
+    $nosort = 1;
     }
 
+    # do we want to put -section as an option for the classifier???
+    #my $thissection = undef;
+
+    #my $option;
+    #foreach $option (@options)
+    #{
+#   if ($option =~ m/^section=(\d+)$/i) 
+#   {
+#       $thissection = $1;
+#   }
+#    }
+
     my $sortmeta = "";
-    if (defined $self->{'sortname'}) {
+    if (!$nosort && defined $self->{'sortname'}) {
     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'});
-        if ($self->{'sortname'} eq "Creator") {
-        &sorttools::format_string_name_english (\$sortmeta);
-        } else {
-        &sorttools::format_string_english (\$sortmeta);
+        $sortmeta = $doc_obj->get_metadata_element($doc_obj->get_top_section(), $self->{'sortname'});
+        if (defined $sortmeta) {
+        $sortmeta = $self->format_metadata_for_sorting($self->{'sortname'}, $sortmeta, $doc_obj);
         }
     }
@@ -106 +95 @@
     }
 
-    if (!defined $thissection)
-    {
-    $thissection = $doc_obj->get_next_section ($doc_obj->get_top_section());
-    while (defined $thissection) {
-        $self->classify_section($thissection, $doc_obj, $sortmeta);
-        $thissection = $doc_obj->get_next_section ($thissection);
-    }
+ #   if (defined $thissection) {
+#   $self->classify_section($thissection, $doc_obj, $sortmeta);
+#    } else    
+ #   {
+    $thissection = $doc_obj->get_next_section ($doc_obj->get_top_section());
+    while (defined $thissection) {
+    $self->classify_section($thissection, $doc_obj, $nosort, $sortmeta);
+    $thissection = $doc_obj->get_next_section ($thissection);
     }
-    else
-    {
-    $self->classify_section($thissection, $doc_obj, $sortmeta);
-    }
+    #}
 }
 
 sub classify_section {
     my $self = shift (@_);
-    my ($section, $doc_obj, $sortmeta) = @_;
+    my ($section, $doc_obj, $nosort, $sortmeta) = @_;
 
     my $doc_OID = $doc_obj->get_OID();
+    $nosort = 0 unless defined $nosort;
     $sortmeta = "" unless defined $sortmeta;
 
+    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($section, $m);
+        $metaname = $m;
+        last if defined $metavalue;
+    } 
+    #if we haven't found a metavalue here, then the section shouldn't be included
+    return unless defined $metavalue;
+    }
+    
+    # we know the section should be included, add it now if we are not sorting
+    if ($nosort) {
+    push (@{$self->{'list'}}, "$doc_OID.$section");
+    return;
+    }
+    # check that it hasn't been added already
+    if (defined $self->{'list'}->{"$doc_OID.$section"}) {
+    my $outhandle = $self->{'outhandle'};
+    print $outhandle "WARNING: SectionList::classify called multiple times for $doc_OID.$section\n";
+    } 
+
     if (defined $self->{'sortname'}) {
-    if (defined $self->{'metaname'}) {
-
-        my $metavalue = $doc_obj->get_metadata_element ($section, $self->{'metaname'});
-        if (defined $metavalue) {
-        if (defined $self->{'list'}->{"$doc_OID.$section"}) {
-            my $outhandle = $self->{'outhandle'};
-            print $outhandle "WARNING: SectionList::classify called multiple times for $doc_OID.$section\n";
-        } 
-        $self->{'list'}->{"$doc_OID.$section"} = $sortmeta;
-        }
-    } else {
-        if (defined $self->{'list'}->{"$doc_OID.$section"}) {
-        my $outhandle = $self->{'outhandle'};
-        print $outhandle "WARNING: SectionList::classify called multiple times for $doc_OID.$section\n";
-        } 
-        $self->{'list'}->{"$doc_OID.$section"} = $sortmeta;
-    }
-
+    # sorting on alternative metadata
+    $self->{'list'}->{"$doc_OID.$section"} = $sortmeta;
     } else {
-    if (defined $self->{'metaname'}) {
-
-        my $metavalue = $doc_obj->get_metadata_element ($section, $self->{'metaname'});
-        if (defined $metavalue) {
-        push (@{$self->{'list'}}, "$doc_OID.$section");
-        }
-    } else {
-        push (@{$self->{'list'}}, "$doc_OID.$section");
-    }
+    # sortingon the classification metadata
+    # do the same formatting on the meta value as for sort meta
+    $metavalue = $self->format_metadata_for_sorting($metaname, $metavalue, $doc_obj);
+    $self->{'list'}->{"$doc_OID.$section"} = $metavalue;
     }
 }
-
 1;