Home » lucene-3.0.1-src » org.apache » lucene » index » [javadoc | source]
abstract public class: TermEnum [javadoc | source]

All Implemented Interfaces:

Direct Known Subclasses:
    FuzzyTermEnum, FilteredTermEnum, InstantiatedTermEnum, FilterTermEnum, TermRangeTermEnum, ParallelTermEnum, MultiTermEnum, WildcardTermEnum, RegexTermEnum, MultiTermEnum, NumericRangeTermEnum, SegmentTermEnum, SingleTermEnum, PrefixTermEnum

Abstract class for enumerating terms.

Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
Method from org.apache.lucene.index.TermEnum Summary:
close,   docFreq,   next,   term
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.index.TermEnum Detail:
 abstract public  void close() throws IOException
    Closes the enumeration to further activity, freeing resources.
 abstract public int docFreq()
    Returns the docFreq of the current Term in the enumeration.
 abstract public boolean next() throws IOException
    Increments the enumeration to the next element. True if one exists.
 abstract public Term term()
    Returns the current Term in the enumeration.