Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters.
More...
#include <TermRangeTermEnum.h>
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.
|
Detailed Description
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.
Constructor & Destructor Documentation
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.)
- Parameters
-
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 Lucene::TermRangeTermEnum::~TermRangeTermEnum |
( |
| ) |
|
|
virtual |
Member Function Documentation
static String Lucene::TermRangeTermEnum::_getClassName |
( |
| ) |
|
|
inlinestatic |
virtual double Lucene::TermRangeTermEnum::difference |
( |
| ) |
|
|
virtual |
virtual bool Lucene::TermRangeTermEnum::endEnum |
( |
| ) |
|
|
protectedvirtual |
virtual String Lucene::TermRangeTermEnum::getClassName |
( |
| ) |
|
|
inlinevirtual |
boost::shared_ptr< TermRangeTermEnum > Lucene::TermRangeTermEnum::shared_from_this |
( |
| ) |
|
|
inline |
virtual bool Lucene::TermRangeTermEnum::termCompare |
( |
const TermPtr & |
term | ) |
|
|
protectedvirtual |
Field Documentation
bool Lucene::TermRangeTermEnum::_endEnum |
|
protected |
String Lucene::TermRangeTermEnum::field |
|
protected |
bool Lucene::TermRangeTermEnum::includeLower |
|
protected |
bool Lucene::TermRangeTermEnum::includeUpper |
|
protected |
StringValue Lucene::TermRangeTermEnum::lowerTermText |
|
protected |
StringValue Lucene::TermRangeTermEnum::upperTermText |
|
protected |
The documentation for this class was generated from the following file: