Package org.apache.lucene.search
Class TermRangeTermEnum
- java.lang.Object
-
- org.apache.lucene.index.TermEnum
-
- org.apache.lucene.search.FilteredTermEnum
-
- org.apache.lucene.search.TermRangeTermEnum
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class TermRangeTermEnum extends FilteredTermEnum
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.
- Since:
- 2.9
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.FilteredTermEnum
actualEnum, currentTerm
-
-
Constructor Summary
Constructors Constructor Description TermRangeTermEnum(IndexReader reader, String field, String lowerTermText, String upperTermText, boolean includeLower, boolean includeUpper, Collator collator)
Enumerates all terms greater/equal thanlowerTerm
but less/equal thanupperTerm
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description float
difference()
Equality measure on the termprotected boolean
endEnum()
Indicates the end of the enumeration has been reachedprotected boolean
termCompare(Term term)
Equality compare on the term
-
-
-
Constructor Detail
-
TermRangeTermEnum
public TermRangeTermEnum(IndexReader reader, String field, String lowerTermText, String upperTermText, boolean includeLower, boolean includeUpper, Collator collator) throws IOException
Enumerates all terms greater/equal thanlowerTerm
but less/equal thanupperTerm
. 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 rangeupperTermText
- The term text at the upper end of the rangeincludeLower
- If true, thelowerTerm
is included in the range.includeUpper
- If true, theupperTerm
is included in the range.collator
- The collator to use to collate index Terms, to determine their membership in the range bounded bylowerTerm
andupperTerm
.- Throws:
IOException
-
-
Method Detail
-
difference
public float difference()
Description copied from class:FilteredTermEnum
Equality measure on the term- Specified by:
difference
in classFilteredTermEnum
-
endEnum
protected boolean endEnum()
Description copied from class:FilteredTermEnum
Indicates the end of the enumeration has been reached- Specified by:
endEnum
in classFilteredTermEnum
-
termCompare
protected boolean termCompare(Term term)
Description copied from class:FilteredTermEnum
Equality compare on the term- Specified by:
termCompare
in classFilteredTermEnum
-
-