CLucene - a full-featured, c++ search engine
API Documentation


lucene::index::TermPositions Class Reference

TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term. More...

#include <Terms.h>

Inheritance diagram for lucene::index::TermPositions:
lucene::index::TermDocs lucene::debug::LuceneBase lucene::index::MultiTermPositions lucene::index::SegmentTermPositions

List of all members.

Public Member Functions

virtual int32_t nextPosition ()=0
virtual ~TermPositions ()
virtual TermDocs__asTermDocs ()=0
 Solve the diamond inheritence problem by providing a reinterpret function.
virtual TermPositions__asTermPositions ()=0
 Solve the diamond inheritence problem by providing a reinterpret function.

Detailed Description

TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.

The document and frequency are the same as for a TermDocs. The positions portion lists the ordinal positions of each occurrence of a term in a document.

See also:
IndexReader::termPositions()

Constructor & Destructor Documentation

virtual lucene::index::TermPositions::~TermPositions (  )  [inline, virtual]

Member Function Documentation

virtual TermDocs* lucene::index::TermPositions::__asTermDocs (  )  [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::MultiTermPositions, and lucene::index::SegmentTermPositions.

virtual TermPositions* lucene::index::TermPositions::__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

Implements lucene::index::TermDocs.

Implemented in lucene::index::MultiTermPositions, and lucene::index::SegmentTermPositions.

virtual int32_t lucene::index::TermPositions::nextPosition (  )  [pure virtual]

The documentation for this class was generated from the following file:

clucene.sourceforge.net