Lucene++ - a full-featured, c++ search engine
API Documentation
Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term. More...
#include <WildcardTermEnum.h>
Public Member Functions | |
WildcardTermEnum (const IndexReaderPtr &reader, const TermPtr &term) | |
Creates a new WildcardTermEnum. | |
virtual | ~WildcardTermEnum () |
virtual String | getClassName () |
boost::shared_ptr< WildcardTermEnum > | 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 bool | wildcardEquals (const String &pattern, int32_t patternIdx, const String &string, int32_t stringIdx) |
Determines if a word matches a wildcard pattern. | |
![]() | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Data Fields | |
TermPtr | searchTerm |
String | field |
String | text |
String | pre |
int32_t | preLen |
bool | _endEnum |
Static Public Attributes | |
static const wchar_t | WILDCARD_STRING |
static const wchar_t | WILDCARD_CHAR |
Protected Member Functions | |
virtual bool | termCompare (const TermPtr &term) |
Equality compare on the term. | |
virtual bool | endEnum () |
Indicates the end of the enumeration has been reached. | |
![]() | |
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 () | |
Additional Inherited Members | |
![]() | |
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 wildcard filter term.
Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
Lucene::WildcardTermEnum::WildcardTermEnum | ( | const IndexReaderPtr & | reader, |
const TermPtr & | term | ||
) |
Creates a new WildcardTermEnum.
After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.
|
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.
|
static |
Determines if a word matches a wildcard pattern.
bool Lucene::WildcardTermEnum::_endEnum |
String Lucene::WildcardTermEnum::field |
String Lucene::WildcardTermEnum::pre |
int32_t Lucene::WildcardTermEnum::preLen |
TermPtr Lucene::WildcardTermEnum::searchTerm |
String Lucene::WildcardTermEnum::text |
|
static |
|
static |