[537] | 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 |
|
---|
[391] | 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 |
|
---|
[3540] | 36 | # 12/05/02 Added usage datastructure - John Thompson
|
---|
| 37 |
|
---|
[391] | 38 | package AZSectionList;
|
---|
| 39 |
|
---|
[1250] | 40 | use AZList;
|
---|
[391] | 41 | use sorttools;
|
---|
| 42 |
|
---|
[10253] | 43 | use strict;
|
---|
| 44 | no strict 'refs'; # allow filehandles to be variables and viceversa
|
---|
| 45 |
|
---|
[1250] | 46 | sub BEGIN {
|
---|
[10253] | 47 | @AZSectionList::ISA = ('AZList');
|
---|
[391] | 48 | }
|
---|
| 49 |
|
---|
[10253] | 50 | my $arguments = [
|
---|
| 51 | ];
|
---|
[4759] | 52 | my $options = { 'name' => "AZSectionList",
|
---|
[5645] | 53 | 'desc' => "{AZSectionList.desc}",
|
---|
[6408] | 54 | 'abstract' => "no",
|
---|
[6969] | 55 | 'inherits' => "yes" };
|
---|
[3540] | 56 |
|
---|
[1839] | 57 |
|
---|
[1483] | 58 | sub new {
|
---|
[10218] | 59 | my ($class) = shift (@_);
|
---|
| 60 | my ($classifierslist,$inputargs,$hashArgOptLists) = @_;
|
---|
| 61 | push(@$classifierslist, $class);
|
---|
[1839] | 62 |
|
---|
[17209] | 63 | push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
|
---|
| 64 | push(@{$hashArgOptLists->{"OptList"}},$options);
|
---|
[3540] | 65 |
|
---|
[12891] | 66 | my $self = new AZList($classifierslist, $inputargs, $hashArgOptLists);
|
---|
[10218] | 67 |
|
---|
[1611] | 68 | return bless $self, $class;
|
---|
[1483] | 69 | }
|
---|
| 70 |
|
---|
[391] | 71 | sub classify {
|
---|
| 72 | my $self = shift (@_);
|
---|
[23116] | 73 | my ($doc_obj) = @_;
|
---|
[391] | 74 |
|
---|
| 75 | my $doc_OID = $doc_obj->get_OID();
|
---|
| 76 | my $thissection = $doc_obj->get_next_section ($doc_obj->get_top_section());
|
---|
| 77 |
|
---|
| 78 | while (defined $thissection) {
|
---|
[23116] | 79 | $self->classify_section ($thissection, $doc_obj);
|
---|
[424] | 80 | $thissection = $doc_obj->get_next_section ($thissection);
|
---|
| 81 | }
|
---|
| 82 | }
|
---|
[391] | 83 |
|
---|
[424] | 84 | sub classify_section {
|
---|
| 85 | my $self = shift (@_);
|
---|
[23116] | 86 | my ($section, $doc_obj) = @_;
|
---|
[391] | 87 |
|
---|
[424] | 88 | my $doc_OID = $doc_obj->get_OID();
|
---|
| 89 |
|
---|
[6969] | 90 | my $metavalue;
|
---|
| 91 | my $metaname;
|
---|
| 92 |
|
---|
| 93 | if (!defined $self->{'meta_list'}) {
|
---|
| 94 | # just in case
|
---|
| 95 | return;
|
---|
| 96 | }
|
---|
| 97 |
|
---|
| 98 | # find the first available metadata
|
---|
[10253] | 99 | foreach my $m (@{$self->{'meta_list'}}) {
|
---|
[6969] | 100 | $metavalue = $doc_obj->get_metadata_element($section, $m);
|
---|
| 101 | $metaname = $m;
|
---|
| 102 | last if defined $metavalue;
|
---|
| 103 | }
|
---|
| 104 |
|
---|
[424] | 105 | # if this section doesn't contain the metadata element we're
|
---|
| 106 | # sorting by we won't include it in this classification
|
---|
[3540] | 107 |
|
---|
[618] | 108 | if (defined $metavalue && $metavalue ne "") {
|
---|
[2954] | 109 | if ($self->{'removeprefix'}) {
|
---|
| 110 | $metavalue =~ s/^$self->{'removeprefix'}//;
|
---|
| 111 | }
|
---|
[6969] | 112 |
|
---|
[10630] | 113 | $metavalue = &sorttools::format_metadata_for_sorting($metaname, $metavalue, $doc_obj) unless $self->{'no_metadata_formatting'};
|
---|
[424] | 114 | if (defined $self->{'list'}->{"$doc_OID.$section"}) {
|
---|
[1483] | 115 | my $outhandle = $self->{'outhandle'};
|
---|
| 116 | print $outhandle "WARNING: AZSectionList::classify called multiple times " .
|
---|
[652] | 117 | "for $doc_OID.$section\n";
|
---|
[424] | 118 | }
|
---|
| 119 | $self->{'list'}->{"$doc_OID.$section"} = $metavalue;
|
---|
[391] | 120 | }
|
---|
| 121 | }
|
---|
| 122 |
|
---|
| 123 |
|
---|
| 124 | 1;
|
---|