Lucene++ - a full-featured, c++ search engine
API Documentation
Subclass of FilteredTermEnum for enumerating a single term. More...
#include <SingleTermEnum.h>
Public Member Functions | |
SingleTermEnum (const IndexReaderPtr &reader, const TermPtr &singleTerm) | |
virtual | ~SingleTermEnum () |
virtual String | getClassName () |
boost::shared_ptr< SingleTermEnum > | shared_from_this () |
virtual double | difference () |
Equality measure on the term. | |
![]() | |
virtual | ~FilteredTermEnum () |
boost::shared_ptr< FilteredTermEnum > | shared_from_this () |
virtual int32_t | docFreq () |
Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated. | |
virtual bool | next () |
Increments the enumeration to the next element. True if one exists. | |
virtual TermPtr | term () |
Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated. | |
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 LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
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 () |
![]() | |
static String | _getClassName () |
Protected Member Functions | |
virtual bool | endEnum () |
Indicates the end of the enumeration has been reached. | |
virtual bool | termCompare (const TermPtr &term) |
Equality compare on the term. | |
![]() | |
virtual void | setEnum (const TermEnumPtr &actualEnum) |
Use this method to set the actual TermEnum (eg. in ctor), it will be automatically positioned on the first matching term. | |
![]() | |
LuceneObject () | |
Protected Attributes | |
TermPtr | singleTerm |
bool | _endEnum |
![]() | |
TermPtr | currentTerm |
The current term. | |
TermEnumPtr | actualEnum |
The delegate enum - to set this member use setEnum . | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Subclass of FilteredTermEnum for enumerating a single term.
This can be used by MultiTermQuery
s that need only visit one term, but want to preserve MultiTermQuery semantics such as MultiTermQuery#rewriteMethod
.
Lucene::SingleTermEnum::SingleTermEnum | ( | const IndexReaderPtr & | reader, |
const TermPtr & | singleTerm | ||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Equality measure on the term.
Implements Lucene::FilteredTermEnum.
|
protectedvirtual |
Indicates the end of the enumeration has been reached.
Implements Lucene::FilteredTermEnum.
|
inlinevirtual |
Reimplemented from Lucene::FilteredTermEnum.
|
inline |
|
protectedvirtual |
Equality compare on the term.
Implements Lucene::FilteredTermEnum.
|
protected |
|
protected |