Class BaseTermsEnum
- All Implemented Interfaces:
BytesRefIterator
- Direct Known Subclasses:
FuzzyTermsEnum,MultiTermsEnum
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus -
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the related attributes.prepareSeekExact(BytesRef text) booleanAttempts to seek to the exact term, returning true if the term is found.voidExpert: Seeks a specific position byTermStatepreviously obtained fromTermsEnum.termState().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, totalTermFreqMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.lucene.util.BytesRefIterator
next
-
Constructor Details
-
BaseTermsEnum
protected BaseTermsEnum()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
termState
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:
-
seekExact
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
-
prepareSeekExact
Description copied from class:TermsEnumTwo-phaseTermsEnum.seekExact(org.apache.lucene.util.BytesRef). The first phase typically callsIndexInput.prefetch(long, long)on the right range of bytes under the hood, while the second phaseIOBooleanSupplier.get()actually seeks the term within these bytes. This can be used to parallelize I/O across multiple terms by callingTermsEnum.prepareSeekExact(org.apache.lucene.util.BytesRef)on multiple terms enums before callingIOBooleanSupplier.get().NOTE: It is illegal to call other methods on this
TermsEnumafter calling this method untilIOBooleanSupplier.get()is called.NOTE: This may return
nullif thisTermsEnumcan identify that the term may not exist without performing any I/O.NOTE: The returned
IOBooleanSuppliermust be consumed in the same thread.- Specified by:
prepareSeekExactin classTermsEnum- Throws:
IOException
-
seekExact
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
Description copied from class:TermsEnumReturns the related attributes.- Specified by:
attributesin classTermsEnum
-