source: trunk/gsdl/perllib/classify/AllList.pm@ 12744

Last change on this file since 12744 was 12744, checked in by kjdon, 17 years ago

added the license info and description

  • Property svn:keywords set to Author Date Id Revision
File size: 3.0 KB
Line 
1###########################################################################
2#
3# AllList.pm -- Creates a single list of all documents. Use by the oaiserver.
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) 2005 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
26package AllList;
27
28use BasClas;
29
30use strict;
31no strict 'refs'; # allow filehandles to be variables and viceversa
32
33sub BEGIN {
34 @AllList::ISA = ('BasClas');
35}
36
37my $arguments =
38 [
39 ];
40
41my $options = { 'name' => "AllList",
42 'desc' => "{AllList.desc}",
43 'abstract' => "no",
44 'inherits' => "yes" };
45
46sub new {
47 my ($class) = shift (@_);
48 my ($classifierslist,$inputargs,$hashArgOptLists) = @_;
49 push(@$classifierslist, $class);
50
51 if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
52 if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
53
54 my $self = (defined $hashArgOptLists)? new BasClas($classifierslist,$inputargs,$hashArgOptLists): new BasClas($classifierslist,$inputargs);
55
56 if ($self->{'info_only'}) {
57 # don't worry about any options etc
58 return bless $self, $class;
59 }
60
61 # Manually set $self parameters.
62 $self->{'list'} = [];
63 $self->{'buttonname'} = "All Documents";
64
65 return bless $self, $class;
66}
67
68sub init {
69 my $self = shift (@_);
70}
71
72sub classify {
73 my $self = shift (@_);
74 my ($doc_obj) = @_;
75
76 my $doc_OID = $doc_obj->get_OID();
77
78 push (@{$self->{'list'}}, $doc_OID);
79
80 return;
81}
82
83sub get_classify_info {
84 my $self = shift(@_);
85 my ($no_thistype) = @_;
86
87 my %classifyinfo = ('childtype' =>'VList',
88 'Title' =>$self->{'buttonname'},
89 'contains' =>[],
90 'classifyOID' =>"oai");
91 $classifyinfo{'thistype'} = 'Invisible';
92 my @list = @{$self->{'list'}};
93
94 my $seqNo = 0;
95 foreach my $OID (@list) {
96 my $hashref={};
97 $hashref->{'OID'}=$OID;
98
99 my %tempinfo=('childtype'=>'VList',
100 'Title'=>$self->{'buttonname'},
101 'classifyOID' =>"oai.$seqNo",
102 'contains' =>[]);
103
104 push (@{$tempinfo{'contains'}}, $hashref);
105
106 push (@{$classifyinfo{'contains'}}, \%tempinfo);
107 $seqNo ++;
108 }
109
110 return \%classifyinfo;
111}
Note: See TracBrowser for help on using the repository browser.