|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.index.TermEnum
org.apache.lucene.search.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.
Constructor Summary | |
---|---|
FilteredTermEnum()
|
Method Summary | |
---|---|
void |
close()
Closes the enumeration to further activity, freeing resources. |
abstract float |
difference()
Equality measure on the term |
int |
docFreq()
Returns the docFreq of the current Term in the enumeration. |
protected abstract boolean |
endEnum()
Indicates 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 |
Methods inherited from class org.apache.lucene.index.TermEnum |
---|
skipTo |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FilteredTermEnum()
Method Detail |
---|
protected abstract boolean termCompare(Term term)
public abstract float difference()
protected abstract boolean endEnum()
protected void setEnum(TermEnum actualEnum) throws IOException
IOException
public int docFreq()
docFreq
in class TermEnum
public boolean next() throws IOException
next
in class TermEnum
IOException
public Term term()
term
in class TermEnum
public void close() throws IOException
close
in class TermEnum
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |