java.lang.Object | ||
↳ | org.apache.lucene.index.TermEnum | |
↳ | org.apache.lucene.search.FilteredTermEnum |
Known Direct Subclasses |
Abstract class for enumerating a subset of all terms.
Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
actualEnum | the delegate enum - to set this member use setEnum(TermEnum) |
||||||||||
currentTerm | the current term |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Closes the enumeration to further activity, freeing resources.
| |||||||||||
Equality measure on the term
| |||||||||||
Returns the docFreq of the current Term in the enumeration.
| |||||||||||
Increments the enumeration to the next element.
| |||||||||||
Returns the current Term in the enumeration.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Indicates the end of the enumeration has been reached
| |||||||||||
use this method to set the actual TermEnum (e.g.
| |||||||||||
Equality compare on the term
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.index.TermEnum
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
|
Closes the enumeration to further activity, freeing resources.
IOException |
---|
Equality measure on the term
Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.
Increments the enumeration to the next element. True if one exists.
IOException |
---|
Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.
Indicates the end of the enumeration has been reached
use this method to set the actual TermEnum (e.g. in ctor), it will be automatically positioned on the first matching term.
IOException |
---|