public class

TermRangeTermEnum

extends FilteredTermEnum
java.lang.Object
   ↳ org.apache.lucene.index.TermEnum
     ↳ org.apache.lucene.search.FilteredTermEnum
       ↳ org.apache.lucene.search.TermRangeTermEnum

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.search.FilteredTermEnum
Public Constructors
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.
Public Methods
float difference()
Equality measure on the term
Protected Methods
boolean endEnum()
Indicates the end of the enumeration has been reached
boolean termCompare(Term term)
Equality compare on the term
[Expand]
Inherited Methods
From class org.apache.lucene.search.FilteredTermEnum
From class org.apache.lucene.index.TermEnum
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public 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. 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
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.
Throws
IOException

Public Methods

public float difference ()

Equality measure on the term

Protected Methods

protected boolean endEnum ()

Indicates the end of the enumeration has been reached

protected boolean termCompare (Term term)

Equality compare on the term