#include <termiterator.h>
Collaboration diagram for Xapian::TermIterator:
Public Types | |
typedef std::input_iterator_tag | iterator_category |
Allow use as an STL iterator. | |
typedef std::string | value_type |
typedef Xapian::termcount_diff | difference_type |
typedef std::string * | pointer |
typedef std::string & | reference |
Public Member Functions | |
TermIterator (Internal *internal_) | |
TermIterator () | |
Default constructor - for declaring an uninitialised iterator. | |
~TermIterator () | |
Destructor. | |
TermIterator (const TermIterator &other) | |
Copying is allowed. | |
void | operator= (const TermIterator &other) |
Assignment is allowed. | |
std::string | operator * () const |
Return the current term. | |
TermIterator & | operator++ () |
TermNameWrapper | operator++ (int) |
void | skip_to (const std::string &tname) |
Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. | |
Xapian::termcount | get_wdf () const |
Return the wdf of the current term (if meaningful). | |
Xapian::doccount | get_termfreq () const |
Return the term frequency of the current term (if meaningful). | |
PositionIterator | positionlist_begin () const |
Return PositionIterator pointing to start of positionlist for current term. | |
PositionIterator | positionlist_end () const |
Return PositionIterator pointing to end of positionlist for current term. | |
std::string | get_description () const |
Returns a string describing this object. | |
Public Attributes | |
Xapian::Internal::RefCntPtr< Internal > | internal |
|
Allow use as an STL iterator.
|
|
Default constructor - for declaring an uninitialised iterator.
|
|
Destructor.
|
|
Copying is allowed. The internals are reference counted, so copying is also cheap. |
|
Returns a string describing this object. Introspection method. |
|
Return the term frequency of the current term (if meaningful).
|
|
Return the wdf of the current term (if meaningful).
|
|
Return the current term.
|
|
Assignment is allowed. The internals are reference counted, so assignment is also cheap. |
|
Return PositionIterator pointing to start of positionlist for current term.
|
|
Return PositionIterator pointing to end of positionlist for current term.
|
|
Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated.
|