1package Xapian::TermIterator;
2
3=head1 NAME
4
5Xapian::TermIterator - Iterate over a list of terms.
6
7=head1 DESCRIPTION
8
9This object represents a stream of terms. It overloads C<++> for
10advancing the iterator, or you can explicitly call the C<inc> method.
11This class also overloads C<eq>, C<ne>, C<==>, and C<!=>.
12
13=head2 Compatibility with Search::Xapian
14
15Search::Xapian overloads <""> (stringification) on this class to call
16the C<get_termname> method.  Call C<get_termname> directly instead.
17
18=head1 METHODS
19
20=over 4
21
22=item new
23
24Constructor. Defaults to a uninitialized iterator.
25
26=item clone
27
28=item inc
29
30Advance the iterator by one. (Called implicitly by C<++> overloading)
31
32=item skip_to <tname>
33
34Skip the iterator to term tname, or the first term after tname if tname
35isn't in the list of terms being iterated.
36
37=item get_termname
38
39Get the name of the current term.
40
41=item get_wdf
42
43Return the wdf of the current term (if meaningful).
44
45=item get_termfreq
46
47Return the term frequency of the current term (if meaningful).
48
49=item positionlist_begin
50
51Return L<Xapian::PositionIterator> pointing to start of positionlist for current term.
52
53=item positionlist_end
54
55Return L<Xapian::PositionIterator> pointing to end of positionlist for current term.
56
57=item get_description
58
59Returns a string describing this object.
60
61=item equal <termiterator>
62
63Checks if a termiterator is the same as this termiterator. Also overloaded as
64the C<eq> and C<==> operators.
65
66=item nequal <termiterator>
67
68Checks if a termiterator is different from this termiterator. Also overloaded
69as the C<ne> and C<!=> operators.
70
71=back
72
73=head1 SEE ALSO
74
75L<Xapian>,
76L<Xapian::Document>
77
78=cut
791;
80