1Xapian::TermIterator(3)User Contributed Perl DocumentatioXnapian::TermIterator(3)
2
3
4

NAME

6       Search::Xapian::TermIterator - Iterate over sets of terms.
7

DESCRIPTION

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

METHODS

15       new Constructor. Defaults to a uninitialized iterator.
16
17       clone
18       inc Advance the iterator by one. (Called implictly by "++" overloading)
19
20       skip_to <tname>
21           Skip the iterator to term tname, or the first term after tname if
22           tname isn't in the list of terms being iterated.
23
24       get_termname
25           Get the name of the current term.
26
27       get_wdf
28           Return the wdf of the current term (if meaningful).
29
30       get_termfreq
31           Return the term frequency of the current term (if meaningful).
32
33       positionlist_begin
34           Return Search::Xapian::PositionIterator pointing to start of
35           positionlist for current term.
36
37       positionlist_end
38           Return Search::Xapian::PositionIterator pointing to end of
39           positionlist for current term.
40
41       get_description
42           Returns a string describing this object.
43
44       equal <termiterator>
45           Checks if a termiterator is the same as this termiterator. Also
46           overloaded as the "eq" and "==" operators.
47
48       nequal <termiterator>
49           Checks if a termiterator is different from this termiterator. Also
50           overloaded as the "ne" and "!=" operators.
51

SEE ALSO

53       Search::Xapian, Search::Xapian::Document
54
55
56
57perl v5.36.0                      2023-01-20           Xapian::TermIterator(3)