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<==>, and C<!=>.
  13
  14 =head2 Compatibility with Search::Xapian
  15
  16 Search::Xapian overloads <""> (stringification) on this class to call
  17 the C<get_description> method.  Call C<get_description> explicitly instead.
  18
  19 Search::Xapian overloads <0+> (convert to an integer) on this class to call
  20 the C<get_docid> method.  Call C<get_docid> explicitly instead.
  21
  22 =head1 METHODS
  23
  24 =over 4
  25
  26 =item new
  27
  28 Constructor. Defaults to an uninitialized iterator.
  29
  30 =item clone
  31
  32 =item inc
  33
  34 Advance the iterator by one. (Called implicitly by C<++> overloading).
  35
  36 =item skip_to <docid>
  37
  38 Advance the iterator to document docid, or the first document after docid if docid
  39 isn't in the list of documents being iterated.
  40
  41 =item get_docid
  42
  43 Get the unique id of the document at the current position of the iterator.
  44
  45 =item get_wdf
  46
  47 Return the wdf for the current position of the iterator.
  48
  49 =item positionlist_begin
  50
  51 Return L<Xapian::PositionIterator> pointing to start of positionlist for
  52 current document.
  53
  54 =item positionlist_end
  55
  56 Return L<Xapian::PositionIterator> pointing to end of positionlist for
  57 current document.
  58
  59 =item get_doclength
  60
  61 Get the length of the document at the current position of the iterator.
  62
  63 =item equal <postingiterator>
  64
  65 Compare for equality with another Xapian::PostingIterator object. Also
  66 overloaded to the C<eq> and C<==> operators.
  67
  68 =item nequal <postingiterator>
  69
  70 Compare for inequality with another Xapian::PostingIterator object. Also
  71 overloaded to the C<ne> and C<!=> operators.
  72
  73 =item get_description
  74
  75 Return a description of this object.
  76
  77 =back
  78
  79 =head1 SEE ALSO
  80
  81 L<Xapian>,
  82 L<Xapian::Database>
  83
  84 =cut
  85 1;