1Xapian::PostingIteratorU(s3e)r Contributed Perl DocumentaXtaipoinan::PostingIterator(3)
2
3
4

NAME

6       Search::Xapian::PostingIterator - Iterate over the list of documents
7       indexed by a term.
8

DESCRIPTION

10       This iterator represents a stream of documents indexed by a term. It
11       overloads "++" for advancing the iterator, or you can explicitly call
12       the "inc" method.  This class also overloads "eq", "ne", "==", "!=",
13       and "" (stringification).
14

METHODS

16       new Constructor. Defaults to an uninitialized iterator.
17
18       clone
19       inc Advance the iterator by one. (Called implictly by "++"
20           overloading).
21
22       skip_to <tname>
23           Skip the iterator to term tname, or the first term after tname if
24           tname isn't in the list of terms being iterated.
25
26       get_docid
27           Get the unique id of this document.
28
29       get_wdf
30           Return the wdf of the current term (if meaningful).
31
32       positionlist_begin
33           Return Search::Xapian::PositionIterator pointing to start of
34           positionlist for current term.
35
36       positionlist_end
37           Return Search::Xapian::PositionIterator pointing to end of
38           positionlist for current term.
39
40       get_doclength
41           Get the length of the document at the current position in the
42           postlist.
43
44           This information may be stored in the postlist, in which case this
45           lookup should be extremely fast (indeed, not require further disk
46           access). If the information is not present in the postlist, it will
47           be retrieved from the database, at a greater performance cost.
48
49       equal <term>
50           Checks if a term is the same as this term. Also overloaded to the
51           "eq" and "==" operators.
52
53       nequal <term>
54           Checks if a term is different from this term. Also overloaded to
55           the "ne" and "!=" operators.
56
57       get_description
58           Return a description of this object.
59

SEE ALSO

61       Search::Xapian, Search::Xapian::Database
62
63
64
65perl v5.36.0                      2022-07-22        Xapian::PostingIterator(3)