org.apache.lucene.search
Class FilteredTermEnum
public abstract class FilteredTermEnum
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.
void | close() - Closes the enumeration to further activity, freeing resources.
|
protected abstract float | difference() - Equality measure on the term
|
int | docFreq() - Returns the docFreq of the current Term in the enumeration.
|
protected abstract boolean | endEnum() - Indiciates the end of the enumeration has been reached
|
boolean | next() - Increments the enumeration to the next element.
|
protected void | setEnum(TermEnum actualEnum)
|
Term | term() - Returns the current Term in the enumeration.
|
protected abstract boolean | termCompare(Term term) - Equality compare on the term
|
FilteredTermEnum
public FilteredTermEnum()
throws IOException
close
public void close()
throws IOException
Closes the enumeration to further activity, freeing resources.
- close in interface TermEnum
difference
protected abstract float difference()
Equality measure on the term
docFreq
public int docFreq()
Returns the docFreq of the current Term in the enumeration.
Initially invalid, valid after next() called for the first time.
- docFreq in interface TermEnum
endEnum
protected abstract boolean endEnum()
Indiciates the end of the enumeration has been reached
next
public boolean next()
throws IOException
Increments the enumeration to the next element. True if one exists.
- next in interface TermEnum
setEnum
protected void setEnum(TermEnum actualEnum)
throws IOException
term
public Term term()
Returns the current Term in the enumeration.
Initially invalid, valid after next() called for the first time.
- term in interface TermEnum
termCompare
protected abstract boolean termCompare(Term term)
Equality compare on the term
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.