xapian-bindings/perl/Xapian/PostingIterator.pm

   1 package Xapian::PostingIterator;
   2
   3 =head1 NAME
   4
   5 Xapian::PostingIterator - Iterate over the list of documents indexed
   6 by a term.
   7
   8 =head1 DESCRIPTION
   9
  10 This iterator represents a stream of documents indexed by a term. It overloads
  11 C<++> for advancing the iterator, or you can explicitly call the C<inc> method.
  12 This class also overloads C<eq>, C<ne>, C<==>, C<!=>, and C<"">
  13 (stringification).
  14
  15 =head1 METHODS
  16
  17 =over 4
  18
  19 =item new
  20
  21 Constructor. Defaults to an uninitialized iterator.
  22
  23 =item clone
  24
  25 =item inc
  26
  27 Advance the iterator by one. (Called implicitly by C<++> overloading).
  28
  29 =item skip_to <tname>
  30
  31 Skip the iterator to term tname, or the first term after tname if tname
  32 isn't in the list of terms being iterated.
  33
  34 =item get_docid
  35
  36 Get the unique id of this document.
  37
  38 =item get_wdf
  39
  40 Return the wdf of the current term (if meaningful).
  41
  42 =item positionlist_begin
  43
  44 Return L<Xapian::PositionIterator> pointing to start of positionlist for current term.
  45
  46 =item positionlist_end
  47
  48 Return L<Xapian::PositionIterator> pointing to end of positionlist for current term.
  49
  50 =item get_doclength
  51
  52 Get the length of the document at the current position in the postlist.
  53
  54 This information may be stored in the postlist, in which case this lookup
  55 should be extremely fast (indeed, not require further disk access). If the
  56 information is not present in the postlist, it will be retrieved from the
  57 database, at a greater performance cost.
  58
  59 =item equal <term>
  60
  61 Checks if a term is the same as this term. Also overloaded to the C<eq>
  62 and C<==> operators.
  63
  64 =item nequal <term>
  65
  66 Checks if a term is different from this term. Also overloaded to the C<ne>
  67 and C<!=> operators.
  68
  69 =item get_description
  70
  71 Return a description of this object.
  72
  73 =back
  74
  75 =head1 SEE ALSO
  76
  77 L<Xapian>,
  78 L<Xapian::Database>
  79
  80 =cut
  81 1;