package Net::Z3950::GRS1;
+## $Id: GRS1.pm,v 1.6 2004-05-28 20:14:28 sondberg Exp $
+##
+## Copyright (c) 2000-2004, Index Data.
+##
+## Permission to use, copy, modify, distribute, and sell this software and
+## its documentation, in whole or in part, for any purpose, is hereby granted,
+## provided that:
+##
+## 1. This copyright and permission notice appear in all copies of the
+## software and its documentation. Notices of copyright or attribution
+## which appear at the beginning of any file must remain unchanged.
+##
+## 2. The name of Index Data or the individual authors may not be used to
+## endorse or promote products derived from this software without specific
+## prior written permission.
+##
+## THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
+## EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
+## WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+## IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
+## INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
+## WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
+## NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
+## LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+## OF THIS SOFTWARE.
+##
+
use strict;
use IO::Handle;
use Carp;
+
sub new {
- my $class = shift;
+ my ($class, $href, $map) = @_;
my $self = {};
$self->{ELEMENTS} = [];
- $self->{FH} = *STDOUT; ## Default output handle is STDOUT
+ $self->{FH} = *STDOUT; ## Default output handle is STDOUT
+ $self->{MAP} = $map;
bless $self, $class;
+ if (defined($href) && ref($href) eq 'HASH') {
+ if (!defined($map)) {
+ croak 'Usage: new Net::Z3950::GRS1($href, $map);';
+ }
+ $self->Hash2grs($href, $map);
+ }
return $self;
}
+sub Hash2grs {
+ my ($self, $href, $mapping) = @_;
+ my $key;
+ my $content;
+ my $aref;
+ my $issue;
+
+ $mapping = defined($mapping) ? $mapping : $self->{MAP};
+ $self->{MAP} = $mapping;
+ foreach $key (keys %$href) {
+ $content = $href->{$key};
+ next unless defined($content);
+ if (!defined($aref = $mapping->{$key})) {
+ print STDERR "Hash2grs: Unmapped key: '$key'\n";
+ next;
+ }
+ if (ref($content) eq 'HASH') { ## Subtree?
+ my $subtree = new Net::Z3950::GRS1($content, $mapping);
+ $self->AddElement($aref->[0], $aref->[1], &Net::Z3950::GRS1::ElementData::Subtree, $subtree);
+ } elsif (!ref($content)) { ## Regular string?
+ $self->AddElement($aref->[0], $aref->[1], &Net::Z3950::GRS1::ElementData::String, $content);
+ } elsif (ref($content) eq 'ARRAY') {
+ my $issues = new Net::Z3950::GRS1;
+ foreach $issue (@$content) {
+ my $entry = new Net::Z3950::GRS1($issue, $mapping);
+ $issues->AddElement(5, 1, &Net::Z3950::GRS1::ElementData::Subtree, $entry);
+ }
+ $self->AddElement($aref->[0], $aref->[1], &Net::Z3950::GRS1::ElementData::Subtree, $issues);
+ } else {
+ print STDERR "Hash2grs: Unsupported content type\n";
+ next;
+ }
+ }
+}
+
+
sub GetElementList {
my $self = shift;
=head1 SYNOPSIS
- use Net::Z3950::Record::GRS1;
+ use Net::Z3950::GRS1;
my $a_grs1_record = new Net::Z3950::Record::GRS1;
my $another_grs1_record = new Net::Z3950::Record::GRS1;
$a_grs1_record->AddElement($type, $value, $content);
- $a_grs1_record->render();
+ $a_grs1_record->Render();
=head1 DESCRIPTION
-Here goes the documentation. I guess, you'll have to wait for it!
+This Perl module helps you to create and manipulate GRS-1 records (generic record syntax).
+So far, you have only access to three methods:
+
+=head2 new
+
+Creates a new GRS-1 object,
+
+ my $grs1 = new Net::Z3950::GRS1;
+
+=head2 AddElement
+
+Lets you add entries to a GRS-1 object. The method should be called this way,
+
+ $grs1->AddElement($type, $value, $which, $content);
+
+where $type should be an integer, and $value is free text. The $which argument should
+contain one of the constants listed in Appendix A. Finally, $content contains the "thing"
+that should be stored in this entry. The structure of $content should match the chosen
+element data type. For
+
+ $which == Net::Z3950::GRS1::ElementData::String;
+
+$content should be some kind of scalar. If on the other hand,
+
+ $which == Net::Z3950::GRS1::ElementData::Subtree;
+
+$content should be a GRS1 object.
+
+=head2 Render
+
+This method digs through the GRS-1 data structure and renders the record. You call it
+this way,
+
+ $grs1->Render();
+
+If you want to access the rendered record through a variable, you can do it like this,
+
+ my $record_as_string;
+ $grs1->Render(POOL => \$record_as_string);
+
+If you want it stored in a file, Render should be called this way,
+
+ $grs1->Render(FILE => 'record.grs1');
+
+When no file name is specified, you can choose to stream the rendered record, for instance,
+
+ $grs1->Render(HANDLE => *STDOUT); ## or
+ $grs1->Render(HANDLE => *STDERR); ## or
+ $grs1->Render(HANDLE => *MY_HANDLE);
+
+=head2 Hash2grs
+
+This method converts a hash into a GRS-1 object. Scalar entries within the hash are converted
+into GRS-1 string elements. A hash entry can itself be a reference to another hash. In this case,
+the new referenced hash will be converted into a GRS-1 subtree. The method is called this way,
+
+ $grs1->Hash2grs($href, $mapping);
+
+where $href is the hash to be converted and $mapping is referenced hash specifying the mapping
+between keys in $href and (type, value) pairs in the $grs1 object. The $mapping hash could
+for instance look like this,
+
+ my $mapping = {
+ title => [2, 1],
+ author => [1, 1],
+ issn => [3, 1]
+ };
+
+If the $grs1 object contains data prior to the invocation of Hash2grs, the new data represented
+by the hash is simply added.
+
+
+=head1 APPENDIX A
+
+These element data types are specified in the Z39.50 protocol:
+
+ Net::Z3950::GRS1::ElementData::Octets
+ Net::Z3950::GRS1::ElementData::Numeric
+ Net::Z3950::GRS1::ElementData::Date
+ Net::Z3950::GRS1::ElementData::Ext
+ Net::Z3950::GRS1::ElementData::String <---
+ Net::Z3950::GRS1::ElementData::TrueOrFalse
+ Net::Z3950::GRS1::ElementData::OID
+ Net::Z3950::GRS1::ElementData::IntUnit
+ Net::Z3950::GRS1::ElementData::ElementNotThere
+ Net::Z3950::GRS1::ElementData::ElementEmpty
+ Net::Z3950::GRS1::ElementData::NoDataRequested
+ Net::Z3950::GRS1::ElementData::Diagnostic
+ Net::Z3950::GRS1::ElementData::Subtree <---
+
+Only the '<---' marked types are so far supported in this package.
=head1 AUTHOR
Specification of the GRS-1 standard, for instance in the Z39.50 protocol specification.
=cut
-
-#$Log: GRS1.pm,v $
-#Revision 1.1 2001-03-13 14:17:15 sondberg
-#Added support for GRS-1.
-#
-