[greenstone-users] OAI data provider with section level metadata

From Vladimir Risojevic
DateTue Jan 18 23:21:05 2011
Subject [greenstone-users] OAI data provider with section level metadata
In-Reply-To (4D338807-70900-cs-waikato-ac-nz)
Skipped content of type multipart/alternative-------------- next part --------------
###########################################################################
#
# AllList.pm -- Creates a single list of all documents. Use by the oaiserver.
# A component of the Greenstone digital library software
# from the New Zealand Digital Library Project at the
# University of Waikato, New Zealand.
#
# Copyright (C) 2005 New Zealand Digital Library Project
#
# December 2010
# Modified to work with sections by Vladimir Risojevic,
# Faculty of Electrical Engineering, University of Banja Luka
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
###########################################################################

package AllList;

use BaseClassifier;

use strict;
no strict 'refs'; # allow filehandles to be variables and viceversa

sub BEGIN {
@AllList::ISA = ('BaseClassifier');
}

my $arguments =
[
];

my $options = { 'name' => "AllList",
'desc' => "{AllList.desc}",
'abstract' => "yes", # hide from gli
'inherits' => "yes" };

sub new {
my ($class) = shift (@_);
my ($classifierslist,$inputargs,$hashArgOptLists) = @_;
push(@$classifierslist, $class);

push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
push(@{$hashArgOptLists->{"OptList"}},$options);

my $self = new BaseClassifier($classifierslist, $inputargs, $hashArgOptLists);

if ($self->{'info_only'}) {
# don't worry about any options etc
return bless $self, $class;
}

# Manually set $self parameters.
$self->{'list'} = [];
$self->{'buttonname'} = "All Documents";

# these should actually be classifier options
# should we classify sections?
$self->{'classify_sections'} = 1;
# the section will be classified if it has a value for one of the metadata elements in this group
$self->{'metadata_group'} = "dc.Title,Title";

return bless $self, $class;
}

sub init {
my $self = shift (@_);
}

# classify which works on sections...
sub classify
{
my $self = shift(@_);
my ($doc_obj, $edit_mode) = @_;

# shall we classify sections ...
if ($self->{'classify_sections'}) {
my $section = $doc_obj->get_next_section($doc_obj->get_top_section());
while (defined $section) {
$self->classify_section($doc_obj, $doc_obj->get_OID() . ".$section", $section, $edit_mode);
$section = $doc_obj->get_next_section($section);
}
}
# ... or documents (top document section)?
else {
$self->classify_section($doc_obj, $doc_obj->get_OID(), $doc_obj->get_top_section(), $edit_mode);
}
}

sub classify_section {
my $self = shift (@_);
my ($doc_obj, $section_OID, $section, $edit_mode) = @_;

# the section will be classified only if it has a value for one of the predefined metadata elements
my $classify_section = 0;
foreach my $metadata_element (split(/;|,/, $self->{'metadata_group'})) {

my $metadata_element_value = $doc_obj->get_metadata_element($section, $metadata_element);
if (defined($metadata_element_value) && $metadata_element_value ne "") {
$classify_section = 1;
last;
}
}

return unless($classify_section);

if ($edit_mode eq "delete") {
$self->oid_array_delete($section_OID,'list');
}
else {
push (@{$self->{'list'}}, $section_OID);
}

return;
}

sub get_classify_info {
my $self = shift(@_);
my ($no_thistype) = @_;

my %classifyinfo = ('childtype' =>'VList',
'Title' =>$self->{'buttonname'},
'contains' =>[],
'classifyOID' =>"oai");
$classifyinfo{'thistype'} = 'Invisible';
my @list = @{$self->{'list'}};

my $seqNo = 0;
foreach my $OID (@list) {
my $hashref={};
$hashref->{'OID'}=$OID;

my %tempinfo=('childtype'=>'VList',
'Title'=>$self->{'buttonname'},
'classifyOID' =>"oai.$seqNo",
'contains' =>[]);

push (@{$tempinfo{'contains'}}, $hashref);

push (@{$classifyinfo{'contains'}}, %tempinfo);
$seqNo ++;
}

return %classifyinfo;
}