Class SingleTermsEnum

  extended by org.apache.lucene.index.TermsEnum
      extended by org.apache.lucene.index.FilteredTermsEnum
          extended by org.apache.lucene.index.SingleTermsEnum
All Implemented Interfaces:

public final class SingleTermsEnum
extends FilteredTermsEnum

Subclass of FilteredTermsEnum for enumerating a single term.

For example, this can be used by MultiTermQuerys that need only visit one term, but want to preserve MultiTermQuery semantics such as MultiTermQuery.getRewriteMethod().

Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.FilteredTermsEnum
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
Field Summary
Fields inherited from class org.apache.lucene.index.TermsEnum
Constructor Summary
SingleTermsEnum(TermsEnum tenum, BytesRef termText)
          Creates a new SingleTermsEnum.
Method Summary
protected  FilteredTermsEnum.AcceptStatus accept(BytesRef term)
          Return if term is accepted, not accepted or the iteration should ended (and possibly seek).
Methods inherited from class org.apache.lucene.index.FilteredTermsEnum
attributes, docFreq, docs, docsAndPositions, getComparator, next, nextSeekTerm, ord, seekCeil, seekExact, seekExact, seekExact, setInitialSeekTerm, term, termState, totalTermFreq
Methods inherited from class org.apache.lucene.index.TermsEnum
docs, docsAndPositions, seekCeil
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public SingleTermsEnum(TermsEnum tenum,
                       BytesRef termText)
Creates a new SingleTermsEnum.

After calling the constructor the enumeration is already pointing to the term, if it exists.

Method Detail


protected FilteredTermsEnum.AcceptStatus accept(BytesRef term)
Description copied from class: FilteredTermsEnum
Return if term is accepted, not accepted or the iteration should ended (and possibly seek).

Specified by:
accept in class FilteredTermsEnum

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