abstract class FSTTermsReader.TermsReader.BaseTermsEnum extends BaseTermsEnum
TermsEnum.SeekStatus
Modifier and Type | Field and Description |
---|---|
(package private) ByteArrayDataInput |
bytesReader |
(package private) FSTTermOutputs.TermData |
meta |
(package private) BlockTermState |
state |
Constructor and Description |
---|
BaseTermsEnum() |
Modifier and Type | Method and Description |
---|---|
(package private) abstract void |
decodeMetaData()
Decodes metadata into customized term state
|
int |
docFreq()
Returns the number of documents containing the current
term.
|
ImpactsEnum |
impacts(int flags)
Return a
ImpactsEnum . |
long |
ord()
Returns ordinal position for current term.
|
PostingsEnum |
postings(PostingsEnum reuse,
int flags)
Get
PostingsEnum for the current term, with
control over whether freqs, positions, offsets or payloads
are required. |
void |
seekExact(long ord)
Seeks to the specified term by ordinal (position) as
previously returned by
TermsEnum.ord() . |
TermState |
termState()
Expert: Returns the TermsEnums internal state to position the TermsEnum
without re-seeking the term dictionary.
|
long |
totalTermFreq()
Returns the total number of occurrences of this term
across all documents (the sum of the freq() for each
doc that has this term).
|
attributes, seekExact, seekExact
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
next
final BlockTermState state
FSTTermOutputs.TermData meta
ByteArrayDataInput bytesReader
BaseTermsEnum() throws java.io.IOException
java.io.IOException
abstract void decodeMetaData() throws java.io.IOException
java.io.IOException
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 BaseTermsEnum
java.io.IOException
TermState
,
TermsEnum.seekExact(BytesRef, TermState)
public int docFreq() throws java.io.IOException
TermsEnum
TermsEnum.SeekStatus.END
.public long totalTermFreq() throws java.io.IOException
TermsEnum
totalTermFreq
in class TermsEnum
java.io.IOException
public PostingsEnum postings(PostingsEnum reuse, int flags) throws java.io.IOException
TermsEnum
PostingsEnum
for the current term, with
control over whether freqs, positions, offsets or payloads
are required. Do not call this when the enum is
unpositioned. This method will not return null.
NOTE: the returned iterator may return deleted documents, so
deleted documents have to be checked on top of the PostingsEnum
.
postings
in class TermsEnum
reuse
- pass a prior PostingsEnum for possible reuseflags
- specifies which optional per-document values
you require; see PostingsEnum.FREQS
java.io.IOException
public ImpactsEnum impacts(int flags) throws java.io.IOException
TermsEnum
ImpactsEnum
.impacts
in class TermsEnum
java.io.IOException
TermsEnum.postings(PostingsEnum, int)
public void seekExact(long ord) throws java.io.IOException
TermsEnum
TermsEnum.ord()
. The target ord
may be before or after the current ord, and must be
within bounds.