public class TermRangeTermEnum extends FilteredTermEnum
Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
actualEnum, currentTerm
Constructor and Description |
---|
TermRangeTermEnum(IndexReader reader,
String field,
String lowerTermText,
String upperTermText,
boolean includeLower,
boolean includeUpper,
Collator collator)
Enumerates all terms greater/equal than
lowerTerm
but less/equal than upperTerm . |
Modifier and Type | Method and Description |
---|---|
float |
difference()
Equality measure on the term
|
protected boolean |
endEnum()
Indicates the end of the enumeration has been reached
|
protected boolean |
termCompare(Term term)
Equality compare on the term
|
public TermRangeTermEnum(IndexReader reader, String field, String lowerTermText, String upperTermText, boolean includeLower, boolean includeUpper, Collator collator) throws IOException
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 rangeupperTermText
- The term text at the upper end of the rangeincludeLower
- 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
.IOException
public float difference()
FilteredTermEnum
difference
in class FilteredTermEnum
protected boolean endEnum()
FilteredTermEnum
endEnum
in class FilteredTermEnum
protected boolean termCompare(Term term)
FilteredTermEnum
termCompare
in class FilteredTermEnum