A Filter that restricts search results to a range of term values in a given field.
More...
#include <TermRangeFilter.h>
|
static String | _getClassName () |
|
static TermRangeFilterPtr | Less (const String &fieldName, StringValue upperTerm) |
| Constructs a filter for field fieldName matching less than or equal to upperTerm.
|
|
static TermRangeFilterPtr | More (const String &fieldName, StringValue lowerTerm) |
| Constructs a filter for field fieldName matching greater than or equal to lowerTerm.
|
|
static String | _getClassName () |
|
static String | _getClassName () |
|
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.
◆ TermRangeFilter()
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.
- Parameters
-
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. |
◆ ~TermRangeFilter()
virtual Lucene::TermRangeFilter::~TermRangeFilter |
( |
| ) |
|
|
virtual |
◆ _getClassName()
static String Lucene::TermRangeFilter::_getClassName |
( |
| ) |
|
|
inlinestatic |
◆ getClassName()
virtual String Lucene::TermRangeFilter::getClassName |
( |
| ) |
|
|
inlinevirtual |
◆ getCollator()
Returns the collator used to determine range inclusion, if any.
◆ getField()
String Lucene::TermRangeFilter::getField |
( |
| ) |
|
Returns the field name for this filter.
◆ getLowerTerm()
String Lucene::TermRangeFilter::getLowerTerm |
( |
| ) |
|
Returns the lower value of this range filter.
◆ getUpperTerm()
String Lucene::TermRangeFilter::getUpperTerm |
( |
| ) |
|
Returns the upper value of this range filter.
◆ includesLower()
bool Lucene::TermRangeFilter::includesLower |
( |
| ) |
|
Returns true if the lower endpoint is inclusive.
◆ includesUpper()
bool Lucene::TermRangeFilter::includesUpper |
( |
| ) |
|
Returns true if the upper endpoint is inclusive.
◆ Less()
static TermRangeFilterPtr Lucene::TermRangeFilter::Less |
( |
const String & |
fieldName, |
|
|
StringValue |
upperTerm |
|
) |
| |
|
static |
Constructs a filter for field fieldName matching less than or equal to upperTerm.
◆ More()
static TermRangeFilterPtr Lucene::TermRangeFilter::More |
( |
const String & |
fieldName, |
|
|
StringValue |
lowerTerm |
|
) |
| |
|
static |
Constructs a filter for field fieldName matching greater than or equal to lowerTerm.
◆ shared_from_this()
boost::shared_ptr< TermRangeFilter > Lucene::TermRangeFilter::shared_from_this |
( |
| ) |
|
|
inline |
The documentation for this class was generated from the following file: