perl/lib/IDZebra/RetrievalRecord.pm

   1 # $Id: RetrievalRecord.pm,v 1.3 2003-03-05 13:55:22 pop Exp $
   2 #
   3 # Zebra perl API header
   4 # =============================================================================
   5 package IDZebra::RetrievalRecord;
   6
   7 use strict;
   8 use warnings;
   9
  10 BEGIN {
  11     use IDZebra;
  12     our $VERSION = do { my @r = (q$Revision: 1.3 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
  13 }
  14
  15 1;
  16 # =============================================================================
  17 # THIS IS Just the documentation, and some access methods...
  18 # The real code is autogenerated by SWIG in IDZebra.pm
  19 # =============================================================================
  20
  21 sub errCode   { $_[0]->{errCode} }
  22 sub errString { $_[0]->{errString} }
  23 sub position  { $_[0]->{position} }
  24 sub base      { $_[0]->{base} }
  25 sub sysno     { $_[0]->{sysno} }
  26 sub score     { $_[0]->{score} }
  27 sub format    { $_[0]->{format} }
  28 sub buf       { $_[0]->{buf} }
  29
  30 # =============================================================================
  31
  32 __END__
  33
  34 =head1 NAME
  35
  36 IDZebra::RetrievalRecord - Structure representing a retrieval record
  37
  38 =head1 SYNOPSIS
  39
  40   foreach my $rec ($rs1->records()) {
  41       unless ($rec->errCode) {
  42          printf  ("Pos:%d, Base: %s, sysno: %d, score %d format: %s\n%s\n\n",
  43              $rec->position,
  44              $rec->base,
  45              $rec->sysno,
  46              $rec->score,
  47              $rec->format,
  48              $rec->buf
  49          );
  50       }
  51   }
  52
  53
  54 =head1 DESCRIPTION
  55
  56 The object represents a Zebra retrieval record, as a "member" of a resultset. It's a read-only object. Beeing a tied reference, access to undefined members ("properties") may hurt.
  57
  58 =head1 PROPERTIES
  59
  60 The following properties are available trough both methods ($rec->errCode) and hash members ($rec->{errCode}):
  61
  62 =over 4
  63
  64 =item B<errCode>
  65
  66 The error code received when fetching this record. 0, if everything went OK.
  67
  68 =item B<errString>
  69
  70 Supplemental error information if applicable.
  71
  72 =item B<position>
  73
  74 Position of record in the resultset.
  75
  76 =item B<base>
  77
  78 The database the record belongs to
  79
  80 =item B<sysno>
  81
  82 System number (unique identifier provided by Zebra for each record)
  83
  84 =item B<score>
  85
  86 The score of the resulting record
  87
  88 =item B<format>
  89
  90 Record format, (Z39.50)
  91
  92 =item B<buf>
  93
  94 The record data itself
  95
  96 =back
  97
  98 =head1 COPYRIGHT
  99
 100 Fill in
 101
 102 =head1 AUTHOR
 103
 104 Peter Popovics, pop@technomat.hu
 105
 106 =head1 SEE ALSO
 107
 108 Zebra documentation, IDZebra::Session, IDZebra::ResultSet manpages.
 109
 110 =cut
 111