NAME
Search::Xapian::PositionIterator - Iterate over sets of positions.
DESCRIPTION
This iterator represents a stream of positions for a term. It overloads ++ for advancing the iterator, or you can explicitly call the inc method. This class also overloads 'eq', 'ne', '==', '!=', and "" (stringification).
METHODS
- new
-
Constructor. Defaults to an uninitialized iterator.
- clone
- inc
-
Advance the iterator by one. (Called implictly by '++' overloading).
- skip_to <tname>
-
Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated.
- get_position
-
Returns the current position.
- equal <term>
-
Checks if a term is the same as this term. Also overloaded to the 'eq' and '==' operators.
- nequal <term>
-
Checks if a term is different from this term. Also overloaded to the 'ne' and '!=' operators.
- get_termpos <term>
-
Return the term position the iterator is currently on. Also implemented as stringification.
- get_description
-
Returns a string describing this object. (for introspection)