lucene::index::SegmentTermEnum Class Reference
SegmentTermEnum is an enumeration of all Terms and TermInfos. More...
#include <SegmentTermEnum.h>
Public Member Functions | |
| SegmentTermEnum (lucene::store::IndexInput *i, FieldInfos *fis, const bool isi) | |
| Constructor. | |
| ~SegmentTermEnum () | |
| Destructor. | |
| bool | next () |
| Moves the current of the set to the next in the set. | |
| Term * | term () |
| Returns a pointer to the current term. | |
| Term * | term (bool pointer) |
| Returns the current term. | |
| void | scanTo (const Term *term) |
| Scan for Term term without allocating new Terms. | |
| void | close () |
| Closes the enumeration to further activity, freeing resources. | |
| int32_t | docFreq () const |
| Returns the document frequency of the current term in the set. | |
| void | seek (const int64_t pointer, const int32_t p, Term *t, TermInfo *ti) |
| Repositions term and termInfo within the enumeration. | |
| TermInfo * | getTermInfo () const |
| Returns a clone of the current termInfo. | |
| void | getTermInfo (TermInfo *ti) const |
| Retrieves a clone of termInfo through the reference ti. | |
| int64_t | freqPointer () const |
| Returns the freqPointer from the current TermInfo in the enumeration. | |
| int64_t | proxPointer () const |
| Returns the proxPointer from the current TermInfo in the enumeration. | |
| SegmentTermEnum * | clone () const |
| Returns a clone of this instance. | |
| const char * | getObjectName () |
| Because we need to know how to cast the object, we need the objects name. | |
Static Public Member Functions | |
| static const char * | getClassName () |
Protected Member Functions | |
| SegmentTermEnum (const SegmentTermEnum &clone) | |
| Constructor. | |
Friends | |
| class | TermInfosReader |
| class | SegmentTermDocs |
Detailed Description
SegmentTermEnum is an enumeration of all Terms and TermInfos.
Constructor & Destructor Documentation
| lucene::index::SegmentTermEnum::SegmentTermEnum | ( | const SegmentTermEnum & | clone | ) | [protected] |
Constructor.
The instance is created by cloning all properties of clone
| lucene::index::SegmentTermEnum::SegmentTermEnum | ( | lucene::store::IndexInput * | i, | |
| FieldInfos * | fis, | |||
| const bool | isi | |||
| ) |
Constructor.
| lucene::index::SegmentTermEnum::~SegmentTermEnum | ( | ) |
Destructor.
Member Function Documentation
| SegmentTermEnum* lucene::index::SegmentTermEnum::clone | ( | ) | const |
Returns a clone of this instance.
| void lucene::index::SegmentTermEnum::close | ( | ) | [virtual] |
Closes the enumeration to further activity, freeing resources.
Implements lucene::index::TermEnum.
| int32_t lucene::index::SegmentTermEnum::docFreq | ( | ) | const [virtual] |
Returns the document frequency of the current term in the set.
Implements lucene::index::TermEnum.
| int64_t lucene::index::SegmentTermEnum::freqPointer | ( | ) | const |
Returns the freqPointer from the current TermInfo in the enumeration.
| static const char* lucene::index::SegmentTermEnum::getClassName | ( | ) | [inline, static] |
| const char* lucene::index::SegmentTermEnum::getObjectName | ( | ) | [inline, virtual] |
Because we need to know how to cast the object, we need the objects name.
Implements lucene::index::TermEnum.
| void lucene::index::SegmentTermEnum::getTermInfo | ( | TermInfo * | ti | ) | const |
Retrieves a clone of termInfo through the reference ti.
| TermInfo* lucene::index::SegmentTermEnum::getTermInfo | ( | ) | const |
Returns a clone of the current termInfo.
| bool lucene::index::SegmentTermEnum::next | ( | ) | [virtual] |
Moves the current of the set to the next in the set.
Implements lucene::index::TermEnum.
| int64_t lucene::index::SegmentTermEnum::proxPointer | ( | ) | const |
Returns the proxPointer from the current TermInfo in the enumeration.
| void lucene::index::SegmentTermEnum::scanTo | ( | const Term * | term | ) |
Scan for Term term without allocating new Terms.
| void lucene::index::SegmentTermEnum::seek | ( | const int64_t | pointer, | |
| const int32_t | p, | |||
| Term * | t, | |||
| TermInfo * | ti | |||
| ) |
Repositions term and termInfo within the enumeration.
| Term* lucene::index::SegmentTermEnum::term | ( | bool | pointer | ) | [virtual] |
Returns the current term.
Reimplemented from lucene::index::TermEnum.
| Term* lucene::index::SegmentTermEnum::term | ( | ) | [virtual] |
Returns a pointer to the current term.
Implements lucene::index::TermEnum.
Friends And Related Function Documentation
friend class SegmentTermDocs [friend] |
friend class TermInfosReader [friend] |
The documentation for this class was generated from the following file: