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
21       skip_to <tname>
22           Skip the iterator to term tname, or the first term after tname if
23           tname isn't in the list of terms being iterated.
24
25       get_termname
26           Get the name of the current term.
27
28       get_wdf
29           Return the wdf of the current term (if meaningful).
30
31       get_termfreq
32           Return the term frequency of the current term (if meaningful).
33
34       positionlist_begin
35           Return Search::Xapian::PositionIterator pointing to start of
36           positionlist for current term.
37
38       positionlist_end
39           Return Search::Xapian::PositionIterator pointing to end of
40           positionlist for current term.
41
42       get_description
43           Returns a string describing this object.
44
45       equal <termiterator>
46           Checks if a termiterator is the same as this termiterator. Also
47           overloaded as the "eq" and "!=" operators.
48
49       nequal <termiterator>
50           Checks if a termiterator is different from this termiterator. Also
51           overloaded as the "ne" and "!=" operators.
52

SEE ALSO

54       Search::Xapian,Search::Xapian::Document
55
56
57
58perl v5.12.0                      2010-04-27           Xapian::TermIterator(3)