Updated documentation, ERADME, scanning, sorting and filter virtual file handles...

[idzebra-moved-to-github.git] / perl / lib / IDZebra / ScanEntry.pm

diff --git a/perl/lib/IDZebra/ScanEntry.pm b/perl/lib/IDZebra/ScanEntry.pm
index 1ee9779..eddf3a6 100644 (file)
--- a/perl/lib/IDZebra/ScanEntry.pm
+++ b/perl/lib/IDZebra/ScanEntry.pm
@@ -1,4 +1,4 @@
-# $Id: ScanEntry.pm,v 1.1 2003-03-04 19:33:52 pop Exp $
+# $Id: ScanEntry.pm,v 1.2 2003-03-05 13:55:22 pop Exp $
 # 
 # Zebra perl API header
 # =============================================================================
@@ -12,7 +12,7 @@ BEGIN {
     use IDZebra::Logger qw(:flags :calls);
     use Scalar::Util qw(weaken);
     use Carp;
-    our $VERSION = do { my @r = (q$Revision: 1.1 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; 
+    our $VERSION = do { my @r = (q$Revision: 1.2 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; 
 }
 
 1;
@@ -60,10 +60,38 @@ IDZebra::ScanEntry - An entry of the scan results
 
 =head1 SYNOPSIS
 
+  foreach my $se ($sl->entries()) {
+      print STDERR ($se->position ,": ",
+                   $se->term() . " (",
+                   $se->occurrences() . "\n");
+  }
+ 
 =head1 DESCRIPTION
 
+A scan entry describes occurrence of a term in the scanned index.
+
 =head1 PROPERTIES
 
+=over 4
+
+=item B<term>
+
+The term itself.
+
+=item B<position>
+
+Position of term in the list. 1 based.
+
+=item B<occurrences>
+
+The occurrence count of the term in the selected database(s).
+
+=back 
+
+=head1 TODO
+
+A I<resultSet> and maybe a I<records> method, to reach the records, where the term occurred.
+
 =head1 COPYRIGHT
 
 Fill in