org.apache.lucene.index

Class FilterIndexReader.FilterTermEnum

Enclosing Class:
FilterIndexReader

public static class FilterIndexReader.FilterTermEnum
extends TermEnum

Base class for filtering TermEnum implementations.

Field Summary

protected TermEnum
in

Constructor Summary

FilterTermEnum(TermEnum in)

Method Summary

void
close()
Closes the enumeration to further activity, freeing resources.
int
docFreq()
Returns the docFreq of the current Term in the enumeration.
boolean
next()
Increments the enumeration to the next element.
Term
term()
Returns the current Term in the enumeration.

Methods inherited from class org.apache.lucene.index.TermEnum

close, docFreq, next, skipTo, term

Field Details

in

protected TermEnum in

Constructor Details

FilterTermEnum

public FilterTermEnum(TermEnum in)

Method Details

close

public void close()
            throws IOException
Closes the enumeration to further activity, freeing resources.
Overrides:
close in interface TermEnum

docFreq

public int docFreq()
Returns the docFreq of the current Term in the enumeration.
Overrides:
docFreq in interface TermEnum

next

public boolean next()
            throws IOException
Increments the enumeration to the next element. True if one exists.
Overrides:
next in interface TermEnum

term

public Term term()
Returns the current Term in the enumeration.
Overrides:
term in interface TermEnum

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.