Package org.apache.lucene.index
Class BaseTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
- Direct Known Subclasses:
MultiTermsEnum
public abstract class BaseTermsEnum extends TermsEnum
A base TermsEnum that adds default implementations for In some cases, the default implementation may be slow and consume huge memory, so subclass SHOULD have its own implementation if possible.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedBaseTermsEnum()Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeSourceattributes()Returns the related attributes.booleanseekExact(BytesRef text)Attempts to seek to the exact term, returning true if the term is found.voidseekExact(BytesRef term, TermState state)Expert: Seeks a specific position byTermStatepreviously obtained fromTermsEnum.termState().TermStatetermState()Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.-
Methods inherited from class org.apache.lucene.index.TermsEnum
docFreq, impacts, ord, postings, postings, seekCeil, seekExact, term, totalTermFreq
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.util.BytesRefIterator
next
-
-
-
-
Method Detail
-
termState
public TermState termState() throws IOException
Description copied from class:TermsEnumExpert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.NOTE: A seek by
TermStatemight not capture theAttributeSource's state. Callers must maintain theAttributeSourcestates separately- Specified by:
termStatein classTermsEnum- Throws:
IOException- See Also:
TermState,TermsEnum.seekExact(BytesRef, TermState)
-
seekExact
public boolean seekExact(BytesRef text) throws IOException
Description copied from class:TermsEnumAttempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster thanTermsEnum.seekCeil(org.apache.lucene.util.BytesRef).- Specified by:
seekExactin classTermsEnum- Returns:
- true if the term is found; return false if the enum is unpositioned.
- Throws:
IOException
-
seekExact
public void seekExact(BytesRef term, TermState state) throws IOException
Description copied from class:TermsEnumExpert: Seeks a specific position byTermStatepreviously obtained fromTermsEnum.termState(). Callers should maintain theTermStateto use this method. Low-level implementations may position the TermsEnum without re-seeking the term dictionary.Seeking by
TermStateshould only be used iff the state was obtained from the sameTermsEnuminstance.NOTE: Using this method with an incompatible
TermStatemight leave thisTermsEnumin undefined state. On a segment levelTermStateinstances are compatible only iff the source and the targetTermsEnumoperate on the same field. If operating on segment level, TermState instances must not be used across segments.NOTE: A seek by
TermStatemight not restore theAttributeSource's state.AttributeSourcestates must be maintained separately if this method is used.- Specified by:
seekExactin classTermsEnum- Parameters:
term- the term the TermState corresponds tostate- theTermState- Throws:
IOException
-
attributes
public AttributeSource attributes()
Description copied from class:TermsEnumReturns the related attributes.- Specified by:
attributesin classTermsEnum
-
-