org.apache.lucene.search

Class FilteredTermEnum

public abstract class FilteredTermEnum extends TermEnum

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
voidclose()
Closes the enumeration to further activity, freeing resources.
abstract floatdifference()
Equality measure on the term
intdocFreq()
Returns the docFreq of the current Term in the enumeration.
protected abstract booleanendEnum()
Indiciates the end of the enumeration has been reached
booleannext()
Increments the enumeration to the next element.
protected voidsetEnum(TermEnum actualEnum)
Termterm()
Returns the current Term in the enumeration.
protected abstract booleantermCompare(Term term)
Equality compare on the term

Constructor Detail

FilteredTermEnum

public FilteredTermEnum()

Method Detail

close

public void close()
Closes the enumeration to further activity, freeing resources.

difference

public abstract float difference()
Equality measure on the term

docFreq

public int docFreq()
Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.

endEnum

protected abstract boolean endEnum()
Indiciates the end of the enumeration has been reached

next

public boolean next()
Increments the enumeration to the next element. True if one exists.

setEnum

protected void setEnum(TermEnum actualEnum)

term

public Term term()
Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.

termCompare

protected abstract boolean termCompare(Term term)
Equality compare on the term
Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.