source: trunk/gsdl/perllib/classify/AZSectionList.pm@ 2022

Last change on this file since 2022 was 2022, checked in by sjboddie, 23 years ago

Caught some of the classifiers up with the documentation (finally). The
old "title" option has been replaced with the "buttonname" option.

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 3.2 KB
Line 
1###########################################################################
2#
3# AZSectionList.pm --
4# A component of the Greenstone digital library software
5# from the New Zealand Digital Library Project at the
6# University of Waikato, New Zealand.
7#
8# Copyright (C) 1999 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 2 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program; if not, write to the Free Software
22# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23#
24###########################################################################
25
26# classifier plugin for sorting sections alphabetically
27
28# this is very similar to AZList except it sorts by
29# section level metadata (excluding the top level)
30# instead of just top level metadata
31
32# the only change is to the classify() subroutine which
33# must now iterate through each section, adding each
34# to the classification
35
36package AZSectionList;
37
38use AZList;
39use sorttools;
40
41sub BEGIN {
42 @ISA = ('AZList');
43}
44
45sub print_usage {
46 print STDERR "
47 usage: classify AZSectionList [options]
48 options:
49
50 -metadata X Metadata field used for classification,
51 list will be sorted by this element.
52
53 -buttonname X (OPTIONAL) Title field for this classification.
54 if not included title field will be Metaname.
55
56This is very similar to AZList except it sorts by section level metadata
57(excluding the top level) instead of just top level metadata.
58";
59}
60
61sub new {
62 my $class = shift (@_);
63 my $self = new AZList($class, @_);
64
65 return bless $self, $class;
66}
67
68sub classify {
69 my $self = shift (@_);
70 my ($doc_obj) = @_;
71
72 my $doc_OID = $doc_obj->get_OID();
73 my $thissection = $doc_obj->get_next_section ($doc_obj->get_top_section());
74
75 while (defined $thissection) {
76 $self->classify_section ($thissection, $doc_obj);
77 $thissection = $doc_obj->get_next_section ($thissection);
78 }
79}
80
81sub classify_section {
82 my $self = shift (@_);
83 my ($section, $doc_obj) = @_;
84
85 my $doc_OID = $doc_obj->get_OID();
86 my $metavalue = $doc_obj->get_metadata_element ($section, $self->{'metaname'});
87
88 # if this section doesn't contain the metadata element we're
89 # sorting by we won't include it in this classification
90 if (defined $metavalue && $metavalue ne "") {
91 if ($self->{'metaname'} eq 'Creator') {
92 &sorttools::format_string_name_english (\$metavalue);
93 } else {
94 &sorttools::format_string_english (\$metavalue);
95 }
96 if (defined $self->{'list'}->{"$doc_OID.$section"}) {
97 my $outhandle = $self->{'outhandle'};
98 print $outhandle "WARNING: AZSectionList::classify called multiple times " .
99 "for $doc_OID.$section\n";
100 }
101 $self->{'list'}->{"$doc_OID.$section"} = $metavalue;
102 }
103}
104
105
1061;
Note: See TracBrowser for help on using the repository browser.