source: trunk/gsdl/perllib/ascii_doc.pm@ 833

###########################################################################
#
# ascii_doc.pm --
# A component of the Greenstone digital library software
# from the New Zealand Digital Library Project at the 
# University of Waikato, New Zealand.
#
# Copyright (C) 1999 New Zealand Digital Library Project
#
# 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.
#
###########################################################################

# class to hold documents

package ascii_doc;

use basedoc;


BEGIN {
    @ISA = ('basedoc');
}

# the document type may be indexed_doc, nonindexed_doc, or
# classification

sub new {
    my $class = shift (@_);
    my ($source_filename, $doc_type) = @_;
    
    my $self = new basedoc();

    push (@{$self->{'metadata'}}, ["gsdlsourcefilename", $source_filename]) 
    if defined $source_filename;

    push (@{$self->{'metadata'}}, ["gsdldoctype", $doc_type]) 
    if defined $doc_type;

    bless ($self, $class);
    return $self;
}

# methods for dealing with metadata

# set_metadata_element and get_metadata_element are for metadata
# which should only have one value. add_meta_data and get_metadata
# are for metadata which can have more than one value.


# set_metadata_element assumes the text is in ASCII form (subset of UTF8)
sub set_metadata_element {
    my $self = shift (@_);
    my ($section, $field, $value) = @_;

    $self->delete_metadata ($section, $field);
    $self->add_metadata ($section, $field, $value);
}

# add_metadata assumes the text is in ASCII form (subset of UTF8)
sub add_metadata {
    my $self = shift (@_);
    my ($section, $field, $value) = @_;

    my $section_ptr = $self->_lookup_section($section);
    if (!defined $section_ptr) {
    print STDERR "doc::add_metadata couldn't find section " .
        "$section\n";
    return;
    }
    
    push (@{$section_ptr->{'metadata'}}, [$field, $value]);
}


# methods for dealing with text

# add_text assumes the text is in ASCII form (subset of UTF8)
sub add_text {
    my $self = shift (@_);
    my ($section, $text) = @_;

    my $section_ptr = $self->_lookup_section($section);
    if (!defined $section_ptr) {
    print STDERR "doc::add_text couldn't find section " .
        "$section\n";
    return;
    }

    $section_ptr->{'text'} .= $text;
}

1;