ContiguousAllDocsPostList Class Reference
A PostList iteratating all docids when they form a contiguous range. More...
#include <contiguousalldocspostlist.h>
Public Member Functions | |
| ContiguousAllDocsPostList (Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > db_, Xapian::doccount doccount_) | |
| Constructor. | |
| Xapian::doccount | get_termfreq () const |
| Return the term frequency. | |
| Xapian::docid | get_docid () const |
| Return the current docid. | |
| Xapian::termcount | get_doclength () const |
| Return the length of current document. | |
| Xapian::termcount | get_wdf () const |
| Always return 1 (wdf isn't totally meaningful for us). | |
| PositionList * | read_position_list () |
| Throws InvalidOperationError. | |
| PositionList * | open_position_list () const |
| Throws InvalidOperationError. | |
| PostList * | next (Xapian::weight w_min) |
| Advance to the next document. | |
| PostList * | skip_to (Xapian::docid target, Xapian::weight w_min) |
| Skip ahead to next document with docid >= target. | |
| bool | at_end () const |
| Return true if and only if we're off the end of the list. | |
| std::string | get_description () const |
| Return a string description of this object. | |
Private Member Functions | |
| void | operator= (const ContiguousAllDocsPostList &) |
| Don't allow assignment. | |
| ContiguousAllDocsPostList (const ContiguousAllDocsPostList &) | |
| Don't allow copying. | |
Private Attributes | |
| Xapian::Internal::RefCntPtr < const Xapian::Database::Internal > | db |
| The database we're iterating over. | |
| Xapian::docid | did |
| The current document id. | |
| Xapian::doccount | doccount |
| The number of documents in the database. | |
Detailed Description
A PostList iteratating all docids when they form a contiguous range.Definition at line 31 of file contiguousalldocspostlist.h.
Constructor & Destructor Documentation
| ContiguousAllDocsPostList::ContiguousAllDocsPostList | ( | const ContiguousAllDocsPostList & | ) | [private] |
Don't allow copying.
| ContiguousAllDocsPostList::ContiguousAllDocsPostList | ( | Xapian::Internal::RefCntPtr< const Xapian::Database::Internal > | db_, | |
| Xapian::doccount | doccount_ | |||
| ) | [inline] |
Member Function Documentation
| bool ContiguousAllDocsPostList::at_end | ( | ) | const [virtual] |
Return true if and only if we're off the end of the list.
Implements Xapian::PostingIterator::Internal.
Definition at line 102 of file contiguousalldocspostlist.cc.
References db, and Xapian::Internal::RefCntPtr< T >::get().
Referenced by get_docid(), get_doclength(), get_wdf(), next(), and skip_to().
| string ContiguousAllDocsPostList::get_description | ( | ) | const [virtual] |
Return a string description of this object.
Implements Xapian::PostingIterator::Internal.
Definition at line 108 of file contiguousalldocspostlist.cc.
References doccount, and Xapian::Internal::str().
| Xapian::docid ContiguousAllDocsPostList::get_docid | ( | ) | const [virtual] |
Return the current docid.
Implements Xapian::PostingIterator::Internal.
Definition at line 39 of file contiguousalldocspostlist.cc.
| Xapian::termcount ContiguousAllDocsPostList::get_doclength | ( | ) | const [virtual] |
Return the length of current document.
Implements Xapian::PostingIterator::Internal.
Definition at line 47 of file contiguousalldocspostlist.cc.
| Xapian::doccount ContiguousAllDocsPostList::get_termfreq | ( | ) | const [virtual] |
Return the term frequency.
For an all documents postlist, this is the number of documents in the database.
Implements LeafPostList.
Definition at line 33 of file contiguousalldocspostlist.cc.
References doccount.
| Xapian::termcount ContiguousAllDocsPostList::get_wdf | ( | ) | const [virtual] |
Always return 1 (wdf isn't totally meaningful for us).
Reimplemented from Xapian::PostingIterator::Internal.
Definition at line 55 of file contiguousalldocspostlist.cc.
| PostList * ContiguousAllDocsPostList::next | ( | Xapian::weight | w_min | ) | [virtual] |
Advance to the next document.
Implements Xapian::PostingIterator::Internal.
Definition at line 76 of file contiguousalldocspostlist.cc.
| PositionList * ContiguousAllDocsPostList::open_position_list | ( | ) | const [virtual] |
Throws InvalidOperationError.
Reimplemented from Xapian::PostingIterator::Internal.
Definition at line 70 of file contiguousalldocspostlist.cc.
Referenced by read_position_list().
| void ContiguousAllDocsPostList::operator= | ( | const ContiguousAllDocsPostList & | ) | [private] |
Don't allow assignment.
| PositionList * ContiguousAllDocsPostList::read_position_list | ( | ) | [virtual] |
Throws InvalidOperationError.
Reimplemented from Xapian::PostingIterator::Internal.
Definition at line 63 of file contiguousalldocspostlist.cc.
References open_position_list().
| PostList * ContiguousAllDocsPostList::skip_to | ( | Xapian::docid | target, | |
| Xapian::weight | w_min | |||
| ) | [virtual] |
Skip ahead to next document with docid >= target.
Implements Xapian::PostingIterator::Internal.
Definition at line 88 of file contiguousalldocspostlist.cc.
Member Data Documentation
Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> ContiguousAllDocsPostList::db [private] |
The database we're iterating over.
Definition at line 39 of file contiguousalldocspostlist.h.
Referenced by at_end(), get_doclength(), next(), and skip_to().
Xapian::docid ContiguousAllDocsPostList::did [private] |
The current document id.
Definition at line 42 of file contiguousalldocspostlist.h.
Referenced by get_docid(), get_doclength(), get_wdf(), next(), and skip_to().
The number of documents in the database.
Definition at line 45 of file contiguousalldocspostlist.h.
Referenced by get_description(), get_termfreq(), next(), and skip_to().
The documentation for this class was generated from the following files:
- common/contiguousalldocspostlist.h
- backends/contiguousalldocspostlist.cc