-
-
27 Feb 2022 23:58:59 UTC
- Distribution: Search-Xapian
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (19 / 0 / 0)
- Kwalitee
Bus factor: 2- License: perl_5
- Perl: v5.6.0
- Activity
24 month- Tools
- Download (73.2KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- unknown
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Search::Xapian::PostingIterator - Iterate over the list of documents indexed by a term.
DESCRIPTION
This iterator represents a stream of documents indexed by a term. It overloads
++
for advancing the iterator, or you can explicitly call theinc
method. This class also overloadseq
,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_docid
-
Get the unique id of this document.
- get_wdf
-
Return the wdf of the current term (if meaningful).
- positionlist_begin
-
Return Search::Xapian::PositionIterator pointing to start of positionlist for current term.
- positionlist_end
-
Return Search::Xapian::PositionIterator pointing to end of positionlist for current term.
- get_doclength
-
Get the length of the document at the current position in the postlist.
This information may be stored in the postlist, in which case this lookup should be extremely fast (indeed, not require further disk access). If the information is not present in the postlist, it will be retrieved from the database, at a greater performance cost.
- 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_description
-
Return a description of this object.
SEE ALSO
Module Install Instructions
To install Search::Xapian, copy and paste the appropriate command in to your terminal.
cpanm Search::Xapian
perl -MCPAN -e shell install Search::Xapian
For more information on module installation, please visit the detailed CPAN module installation guide.