public abstract class BaseTermsEnum extends TermsEnum
TermsEnum.SeekStatus
Modifier and Type | Field and Description |
---|---|
private AttributeSource |
atts |
Modifier | Constructor and Description |
---|---|
protected |
BaseTermsEnum()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
AttributeSource |
attributes()
Returns the related attributes.
|
boolean |
seekExact(BytesRef text)
Attempts to seek to the exact term, returning true if the term is found.
|
void |
seekExact(BytesRef term,
TermState state)
Expert: Seeks a specific position by
TermState previously obtained
from TermsEnum.termState() . |
TermState |
termState()
Expert: Returns the TermsEnums internal state to position the TermsEnum
without re-seeking the term dictionary.
|
docFreq, impacts, ord, postings, postings, seekCeil, seekExact, term, totalTermFreq
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
next
private AttributeSource atts
protected BaseTermsEnum()
public TermState termState() throws java.io.IOException
TermsEnum
NOTE: A seek by TermState
might not capture the
AttributeSource
's state. Callers must maintain the
AttributeSource
states separately
termState
in class TermsEnum
java.io.IOException
TermState
,
TermsEnum.seekExact(BytesRef, TermState)
public boolean seekExact(BytesRef text) throws java.io.IOException
TermsEnum
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.
public void seekExact(BytesRef term, TermState state) throws java.io.IOException
TermsEnum
TermState
previously obtained
from TermsEnum.termState()
. Callers should maintain the TermState
to
use this method. Low-level implementations may position the TermsEnum
without re-seeking the term dictionary.
Seeking by TermState
should only be used iff the state was obtained
from the same TermsEnum
instance.
NOTE: Using this method with an incompatible TermState
might leave
this TermsEnum
in undefined state. On a segment level
TermState
instances are compatible only iff the source and the
target TermsEnum
operate on the same field. If operating on segment
level, TermState instances must not be used across segments.
NOTE: A seek by TermState
might not restore the
AttributeSource
's state. AttributeSource
states must be
maintained separately if this method is used.
public AttributeSource attributes()
TermsEnum
attributes
in class TermsEnum