Lucene++ - a full-featured, c++ search engine
API Documentation
#include <SegmentTermEnum.h>
Public Member Functions | |
SegmentTermEnum () | |
SegmentTermEnum (const IndexInputPtr &i, const FieldInfosPtr &fis, bool isi) | |
virtual | ~SegmentTermEnum () |
virtual String | getClassName () |
boost::shared_ptr< SegmentTermEnum > | shared_from_this () |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
void | seek (int64_t pointer, int64_t p, const TermPtr &t, const TermInfoPtr &ti) |
virtual bool | next () |
Increments the enumeration to the next element. True if one exists. | |
int32_t | scanTo (const TermPtr &term) |
Optimized scan, without allocating new terms. Return number of invocations to next(). | |
virtual TermPtr | term () |
Returns the current Term in the enumeration. Initially invalid, valid after next() called for the first time. | |
TermPtr | prev () |
Returns the previous Term enumerated. Initially null. | |
TermInfoPtr | termInfo () |
Returns the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time. | |
void | termInfo (const TermInfoPtr &ti) |
Sets the argument to the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time. | |
virtual int32_t | docFreq () |
Returns the docFreq of the current Term in the enumeration. Initially invalid, valid after next() called for the first time. | |
int64_t | freqPointer () |
Returns the freqPointer from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time. | |
int64_t | proxPointer () |
Returns the proxPointer from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time. | |
virtual void | close () |
Closes the enumeration to further activity, freeing resources. | |
![]() | |
virtual | ~TermEnum () |
boost::shared_ptr< TermEnum > | shared_from_this () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Data Fields | |
FieldInfosPtr | fieldInfos |
int64_t | size |
int64_t | position |
int64_t | indexPointer |
int32_t | indexInterval |
int32_t | skipInterval |
int32_t | maxSkipLevels |
Protected Attributes | |
IndexInputPtr | input |
TermBufferPtr | termBuffer |
TermBufferPtr | prevBuffer |
TermBufferPtr | scanBuffer |
TermInfoPtr | _termInfo |
int32_t | format |
bool | isIndex |
int32_t | formatM1SkipInterval |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
Lucene::SegmentTermEnum::SegmentTermEnum | ( | ) |
Lucene::SegmentTermEnum::SegmentTermEnum | ( | const IndexInputPtr & | i, |
const FieldInfosPtr & | fis, | ||
bool | isi | ||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Return clone of this object.
other | clone reference - null when called initially, then set in top virtual override. |
Reimplemented from Lucene::LuceneObject.
|
virtual |
Closes the enumeration to further activity, freeing resources.
Implements Lucene::TermEnum.
|
virtual |
Returns the docFreq of the current Term in the enumeration. Initially invalid, valid after next() called for the first time.
Implements Lucene::TermEnum.
int64_t Lucene::SegmentTermEnum::freqPointer | ( | ) |
|
inlinevirtual |
Reimplemented from Lucene::TermEnum.
|
virtual |
Increments the enumeration to the next element. True if one exists.
Implements Lucene::TermEnum.
int64_t Lucene::SegmentTermEnum::proxPointer | ( | ) |
int32_t Lucene::SegmentTermEnum::scanTo | ( | const TermPtr & | term | ) |
Optimized scan, without allocating new terms. Return number of invocations to next().
void Lucene::SegmentTermEnum::seek | ( | int64_t | pointer, |
int64_t | p, | ||
const TermPtr & | t, | ||
const TermInfoPtr & | ti | ||
) |
|
inline |
|
virtual |
Returns the current Term in the enumeration. Initially invalid, valid after next() called for the first time.
Implements Lucene::TermEnum.
TermInfoPtr Lucene::SegmentTermEnum::termInfo | ( | ) |
void Lucene::SegmentTermEnum::termInfo | ( | const TermInfoPtr & | ti | ) |
|
protected |
FieldInfosPtr Lucene::SegmentTermEnum::fieldInfos |
|
protected |
|
protected |
int32_t Lucene::SegmentTermEnum::indexInterval |
int64_t Lucene::SegmentTermEnum::indexPointer |
|
protected |
|
protected |
int32_t Lucene::SegmentTermEnum::maxSkipLevels |
int64_t Lucene::SegmentTermEnum::position |
|
protected |
|
protected |
int64_t Lucene::SegmentTermEnum::size |
int32_t Lucene::SegmentTermEnum::skipInterval |
|
protected |