Lucene++ - a full-featured, c++ search engine
API Documentation
A Filter that restricts search results to a range of term values in a given field. More...
#include <TermRangeFilter.h>
Public Member Functions | |
TermRangeFilter (const String &fieldName, StringValue lowerTerm, StringValue upperTerm, bool includeLower, bool includeUpper, CollatorPtr collator=CollatorPtr()) | |
Warning: Using this constructor and supplying a non-null value in the collator parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined. Depending on the number of index Terms in this Field, the operation could be very slow. More... | |
virtual | ~TermRangeFilter () |
virtual String | getClassName () |
boost::shared_ptr < TermRangeFilter > | shared_from_this () |
String | getField () |
Returns the field name for this filter. More... | |
String | getLowerTerm () |
Returns the lower value of this range filter. More... | |
String | getUpperTerm () |
Returns the upper value of this range filter. More... | |
bool | includesLower () |
Returns true if the lower endpoint is inclusive. More... | |
bool | includesUpper () |
Returns true if the upper endpoint is inclusive. More... | |
CollatorPtr | getCollator () |
Returns the collator used to determine range inclusion, if any. More... | |
![]() | |
virtual | ~MultiTermQueryWrapperFilter () |
boost::shared_ptr < MultiTermQueryWrapperFilter > | shared_from_this () |
virtual String | toString () |
Returns a string representation of the object. More... | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
int32_t | getTotalNumberOfTerms () |
Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index. More... | |
void | clearTotalNumberOfTerms () |
Resets the counting of unique terms. Do this before executing the filter. More... | |
virtual DocIdSetPtr | getDocIdSet (const IndexReaderPtr &reader) |
Returns a DocIdSet with documents that should be permitted in search results. More... | |
![]() | |
virtual | ~Filter () |
boost::shared_ptr< Filter > | shared_from_this () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. More... | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. More... | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. More... | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. More... | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. More... | |
virtual void | unlock () |
Unlock this object. More... | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. More... | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. More... | |
virtual void | notifyAll () |
Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
static String | _getClassName () |
static TermRangeFilterPtr | Less (const String &fieldName, StringValue upperTerm) |
Constructs a filter for field fieldName matching less than or equal to upperTerm. More... | |
static TermRangeFilterPtr | More (const String &fieldName, StringValue lowerTerm) |
Constructs a filter for field fieldName matching greater than or equal to lowerTerm. More... | |
![]() | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
MultiTermQueryPtr | query |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
A Filter that restricts search results to a range of term values in a given field.
This filter matches the documents looking for terms that fall into the supplied range according to String#compare(String), unless a Collator is provided. It is not intended for numerical ranges; use NumericRangeFilter instead.
If you construct a large number of range filters with different ranges but on the same field, FieldCacheRangeFilter may have significantly better performance.
Lucene::TermRangeFilter::TermRangeFilter | ( | const String & | fieldName, |
StringValue | lowerTerm, | ||
StringValue | upperTerm, | ||
bool | includeLower, | ||
bool | includeUpper, | ||
CollatorPtr | collator = CollatorPtr() |
||
) |
Warning: Using this constructor and supplying a non-null value in the collator parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined. Depending on the number of index Terms in this Field, the operation could be very slow.
lowerTerm | The lower bound on this range |
upperTerm | The upper bound on this range |
includeLower | Does this range include the lower bound? |
includeUpper | Does this range include the upper bound? |
collator | The collator to use when determining range inclusion; set to null to use Unicode code point ordering instead of collation. |
|
virtual |
|
inlinestatic |
|
inlinevirtual |
Reimplemented from Lucene::MultiTermQueryWrapperFilter.
CollatorPtr Lucene::TermRangeFilter::getCollator | ( | ) |
Returns the collator used to determine range inclusion, if any.
String Lucene::TermRangeFilter::getField | ( | ) |
Returns the field name for this filter.
String Lucene::TermRangeFilter::getLowerTerm | ( | ) |
Returns the lower value of this range filter.
String Lucene::TermRangeFilter::getUpperTerm | ( | ) |
Returns the upper value of this range filter.
bool Lucene::TermRangeFilter::includesLower | ( | ) |
Returns true if the lower endpoint is inclusive.
bool Lucene::TermRangeFilter::includesUpper | ( | ) |
Returns true if the upper endpoint is inclusive.
|
static |
Constructs a filter for field fieldName matching less than or equal to upperTerm.
|
static |
Constructs a filter for field fieldName matching greater than or equal to lowerTerm.
|
inline |