Changeset 5532

Timestamp:

2003-09-25T04:32:58+12:00 (21 years ago)

Author:

kjdon

Message:

added -nogroupyears, -sortmeta and -datemeta options. see comment in code for descriptions

File:

• trunk/gsdl/perllib/classify/DateList.pm (modified) (7 diffs)

trunk/gsdl/perllib/classify/DateList.pm

@@ -35 +35 @@
 # 12/05/02 Added usage datastructure - John Thompson
 
+# 23/09/03 Added some more options -kjdon.
+# these include:
+# -nogroupyears, which makes each year an individual entry in 
+# the horizontal list and prevents compaction
+# -datemeta, use a different metadata for the date (instead of Date), still expects yyyymmdd format. this affects display cos greenstone displays Date metadata as dd month yyyy, whereas any other date metadata is displayed as yyyymmdd - this needs fixing
+# -sortmeta specifies an additional metadata to use in sorting, will take affect when two docs have the same date.
+
 package DateList;
 
@@ -48 +55 @@
     'desc' => "{DateList.bymonth}",
     'type' => "flag",
-    'reqd' => "no" } ];
+    'reqd' => "no" },
+
+      { 'name' => "nogroupyears",
+    'desc' => "{DateList.nogroupyears}",
+    'type' => "flag",
+    'reqd' => "no" },
+      { 'name' => "datemeta",
+        'desc' => "{DateList.datemeta}",
+        'type' => "metadata",
+    'deft' => "Date",
+        'reqd' => "no" } ,
+      { 'name' => "sortmeta",
+        'desc' => "{DateList.sortmeta}",
+        'type' => "metadata",
+    'reqd' => "no" } ,
+
+      ];
 
 my $options = { 'name'     => "DateList",
-        'desc'     => "Classifier plugin for sorting by date. Always sorts by 'Date' metadata. Date is assumed to be in the form yyyymmdd.",
+        'desc'     => "Classifier plugin for sorting by date. By default, sorts by 'Date' metadata. Date is assumed to be in the form yyyymmdd.",
         'inherits' => "Yes",
         'args'     => $arguments };
@@ -79 +102 @@
 
     $self->{'list'} = {};
+
+    my ($datemeta, $sortmeta);
     if (!parsargv::parse(\@_, 
                          q^bymonth^, \$self->{'bymonth'},
+             q^nogroupyears^, \$self->{'nogroupyears'},
+             q^datemeta/.*/^, \$datemeta,
+             q^sortmeta/.*/^, \$sortmeta,
                          "allow_extra_options")) {
     $self->print_txt_usage("");  # Use default resource bundle
     die "\n";
     }
+
+    if (!defined $datemeta || $datemeta eq "") {
+    $datemeta = "Date";
+    }
+    $self->{'datemeta'} = $datemeta;
+
+    if (defined $sortmeta && $sortmeta ne "") {
+    $self->{'sortmeta'} = $sortmeta;
+    }
     return bless $self, $class;
 }
@@ -99 +136 @@
 
     my $doc_OID = $doc_obj->get_OID();
-    my $date = $doc_obj->get_metadata_element ($doc_obj->get_top_section(), 'Date');
-
+    my $date = $doc_obj->get_metadata_element ($doc_obj->get_top_section(), $self->{'datemeta'});
+    
+    my $sort_other = "";
+    if (defined $self->{'sortmeta'} && $self->{'sortmeta'} ne "") {
+    $sort_other = $doc_obj->get_metadata_element ($doc_obj->get_top_section(), $self->{'sortmeta'});
+    }
     # if this document doesn't contain Date element we won't 
     # include it in this classification
@@ -108 +149 @@
         print $outhandle "WARNING: DateList::classify called multiple times for $doc_OID\n";
     } 
-    $self->{'list'}->{$doc_OID} = $date;
+
+    
+    $self->{'list'}->{$doc_OID} = "$date$sort_other";
     }
 }
@@ -145 +188 @@
     # top level
     my $childtype = "HList";
-    if (scalar (@$classlistref) <= 39) {$childtype = "DateList";}
+    if (scalar (@$classlistref) <= 39 && !defined $self->{'nogroupyears'}) {$childtype = "DateList";}
     my $classifyinfo = $self->get_entry ("Date", $childtype, "Invisible");
 
-    # don't need to do any splitting if there are less than 39 (max + min -1) classifications
-    if ((scalar @$classlistref) <= 39) {
+    # don't need to do any splitting if there are less than 39 (max + min -1) classifications, unless nogroupyears is specified
+    if ((scalar @$classlistref) <= 39 && !defined $self->{'nogroupyears'}) {
     foreach $subOID (@$classlistref) {
         push (@{$classifyinfo->{'contains'}}, {'OID'=>$subOID});
@@ -178 +221 @@
     }
     }
-    $classhash = $self->compactlist ($classhash);
-
+
+    # only compact the list if nogroupyears not specified
+    if ( !defined $self->{'nogroupyears'}) {
+    $classhash = $self->compactlist ($classhash);
+    }
     foreach $subclass (sort keys %$classhash) {
     my $tempclassify = $self->get_entry($subclass, "DateList");