1 package Xapian
::PostingIterator
;
5 Xapian::PostingIterator - Iterate over the list of documents indexed
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<"">
21 Constructor. Defaults to an uninitialized iterator.
27 Advance the iterator by one. (Called implicitly by C<++> overloading).
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.
36 Get the unique id of this document.
40 Return the wdf of the current term (if meaningful).
42 =item positionlist_begin
44 Return L<Xapian::PositionIterator> pointing to start of positionlist for current term.
46 =item positionlist_end
48 Return L<Xapian::PositionIterator> pointing to end of positionlist for current term.
52 Get the length of the document at the current position in the postlist.
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.
61 Checks if a term is the same as this term. Also overloaded to the C<eq>
66 Checks if a term is different from this term. Also overloaded to the C<ne>
71 Return a description of this object.