Module org.apache.lucene.codecs
Package org.apache.lucene.codecs.memory
Class FSTTermsReader.TermsReader.BaseTermsEnum
java.lang.Object
org.apache.lucene.index.TermsEnum
org.apache.lucene.index.BaseTermsEnum
org.apache.lucene.codecs.memory.FSTTermsReader.TermsReader.BaseTermsEnum
- All Implemented Interfaces:
BytesRefIterator
- Direct Known Subclasses:
FSTTermsReader.TermsReader.IntersectTermsEnum
,FSTTermsReader.TermsReader.SegmentTermsEnum
- Enclosing class:
- FSTTermsReader.TermsReader
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) ByteArrayDataInput
(package private) FSTTermOutputs.TermData
(package private) final BlockTermState
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) abstract void
Decodes metadata into customized term stateint
docFreq()
Returns the number of documents containing the current term.impacts
(int flags) Return aImpactsEnum
.long
ord()
Returns ordinal position for current term.postings
(PostingsEnum reuse, int flags) GetPostingsEnum
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 byTermsEnum.ord()
.Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.long
Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).Methods inherited from class org.apache.lucene.index.BaseTermsEnum
attributes, seekExact, seekExact
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
-
Field Details
-
state
-
meta
-
bytesReader
ByteArrayDataInput bytesReader
-
-
Constructor Details
-
BaseTermsEnum
BaseTermsEnum() throws IOException- Throws:
IOException
-
-
Method Details
-
decodeMetaData
Decodes metadata into customized term state- Throws:
IOException
-
termState
Description copied from class:TermsEnum
Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.NOTE: A seek by
TermState
might not capture theAttributeSource
's state. Callers must maintain theAttributeSource
states separately- Overrides:
termState
in classBaseTermsEnum
- Throws:
IOException
- See Also:
-
docFreq
Description copied from class:TermsEnum
Returns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END
.- Specified by:
docFreq
in classTermsEnum
- Throws:
IOException
-
totalTermFreq
Description copied from class:TermsEnum
Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.- Specified by:
totalTermFreq
in classTermsEnum
- Throws:
IOException
-
postings
Description copied from class:TermsEnum
GetPostingsEnum
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
.- Specified by:
postings
in classTermsEnum
- Parameters:
reuse
- pass a prior PostingsEnum for possible reuseflags
- specifies which optional per-document values you require; seePostingsEnum.FREQS
- Throws:
IOException
-
impacts
Description copied from class:TermsEnum
Return aImpactsEnum
.- Specified by:
impacts
in classTermsEnum
- Throws:
IOException
- See Also:
-
seekExact
Description copied from class:TermsEnum
Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord()
. The target ord may be before or after the current ord, and must be within bounds.- Specified by:
seekExact
in classTermsEnum
- Throws:
IOException
-
ord
public long ord()Description copied from class:TermsEnum
Returns ordinal position for current term. This is an optional method (the codec may throwUnsupportedOperationException
). Do not call this when the enum is unpositioned.
-