lucene::index::TermDocs Class Reference
TermDocs provides an interface for enumerating <document, frequency> pairs for a term. More...
#include <Terms.h>
Public Member Functions | |
| virtual | ~TermDocs () |
| virtual void | seek (Term *term)=0 |
| virtual void | seek (TermEnum *termEnum)=0 |
| Sets this to the data for the current term in a TermEnum. | |
| virtual int32_t | doc () const =0 |
| virtual int32_t | freq () const =0 |
| virtual bool | next ()=0 |
| virtual int32_t | read (int32_t *docs, int32_t *freqs, int32_t length)=0 |
| virtual bool | skipTo (const int32_t target)=0 |
| virtual void | close ()=0 |
| virtual TermPositions * | __asTermPositions ()=0 |
| Solve the diamond inheritence problem by providing a reinterpret function. | |
Detailed Description
TermDocs provides an interface for enumerating <document, frequency> pairs for a term.
The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document.
The pairs are ordered by document number.
- See also:
- IndexReader::termDocs()
Constructor & Destructor Documentation
| virtual lucene::index::TermDocs::~TermDocs | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual TermPositions* lucene::index::TermDocs::__asTermPositions | ( | ) | [pure virtual] |
Solve the diamond inheritence problem by providing a reinterpret function.
No dynamic casting is required and no RTTI data is needed to do this
Implemented in lucene::index::MultiTermDocs, lucene::index::MultiTermPositions, lucene::index::SegmentTermDocs, lucene::index::SegmentTermPositions, and lucene::index::TermPositions.
| virtual void lucene::index::TermDocs::close | ( | ) | [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual int32_t lucene::index::TermDocs::doc | ( | ) | const [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual int32_t lucene::index::TermDocs::freq | ( | ) | const [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual bool lucene::index::TermDocs::next | ( | ) | [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual int32_t lucene::index::TermDocs::read | ( | int32_t * | docs, | |
| int32_t * | freqs, | |||
| int32_t | length | |||
| ) | [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual void lucene::index::TermDocs::seek | ( | TermEnum * | termEnum | ) | [pure virtual] |
Sets this to the data for the current term in a TermEnum.
This may be optimized in some implementations.
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual void lucene::index::TermDocs::seek | ( | Term * | term | ) | [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
| virtual bool lucene::index::TermDocs::skipTo | ( | const int32_t | target | ) | [pure virtual] |
Implemented in lucene::index::MultiTermDocs, lucene::index::SegmentTermDocs, and lucene::index::SegmentTermPositions.
The documentation for this class was generated from the following file: