Lucene++ - a full-featured, c++ search engine
API Documentation
Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters. More...
#include <TermRangeTermEnum.h>
Public Member Functions | |
TermRangeTermEnum (const IndexReaderPtr &reader, const String &field, StringValue lowerTermText, StringValue upperTermText, bool includeLower, bool includeUpper, const CollatorPtr &collator) | |
Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm. | |
virtual | ~TermRangeTermEnum () |
virtual String | getClassName () |
boost::shared_ptr< TermRangeTermEnum > | 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 | |
CollatorPtr | collator |
bool | _endEnum |
String | field |
StringValue | upperTermText |
StringValue | lowerTermText |
bool | includeLower |
bool | includeUpper |
![]() | |
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 all terms that match the specified range parameters.
Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
Lucene::TermRangeTermEnum::TermRangeTermEnum | ( | const IndexReaderPtr & | reader, |
const String & | field, | ||
StringValue | lowerTermText, | ||
StringValue | upperTermText, | ||
bool | includeLower, | ||
bool | includeUpper, | ||
const CollatorPtr & | collator | ||
) |
Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm.
If an endpoint is null, it is said to be "open". Either or both endpoints may be open. Open endpoints may not be exclusive (you can't select all but the first or last term without explicitly specifying the term to exclude.)
reader | |
field | An interned field that holds both lower and upper terms. |
lowerTermText | The term text at the lower end of the range |
upperTermText | The term text at the upper end of the range |
includeLower | If true, the lowerTerm is included in the range. |
includeUpper | If true, the upperTerm is included in the range. |
collator | The collator to use to collate index Terms, to determine their membership in the range bounded by lowerTerm and upperTerm. |
|
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 |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |