Class BlockTermsReader.FieldReader.SegmentTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- org.apache.lucene.codecs.blockterms.BlockTermsReader.FieldReader.SegmentTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
- Enclosing class:
- BlockTermsReader.FieldReader
private final class BlockTermsReader.FieldReader.SegmentTermsEnum extends BaseTermsEnum
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
-
Field Summary
Fields Modifier and Type Field Description private int
blockTermCount
private byte[]
bytes
private ByteArrayDataInput
bytesReader
private boolean
didIndexNext
private byte[]
docFreqBytes
private boolean
doOrd
private BlockTermsReader.FieldAndTerm
fieldTerm
private ByteArrayDataInput
freqReader
private IndexInput
in
private TermsIndexReaderBase.FieldIndexEnum
indexEnum
private boolean
indexIsCurrent
private int
metaDataUpto
private BytesRef
nextIndexTerm
private boolean
seekPending
private BlockTermState
state
private BytesRefBuilder
term
private int
termBlockPrefix
private byte[]
termSuffixes
private ByteArrayDataInput
termSuffixesReader
-
Constructor Summary
Constructors Constructor Description SegmentTermsEnum()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private BytesRef
_next()
private void
decodeMetaData()
int
docFreq()
Returns the number of documents containing the current term.ImpactsEnum
impacts(int flags)
Return aImpactsEnum
.BytesRef
next()
Increments the iteration to the nextBytesRef
in the iterator.private boolean
nextBlock()
long
ord()
Returns ordinal position for current term.PostingsEnum
postings(PostingsEnum reuse, int flags)
GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.TermsEnum.SeekStatus
seekCeil(BytesRef target)
Seeks to the specified term, if it exists, or to the next (ceiling) term.void
seekExact(long ord)
Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord()
.void
seekExact(BytesRef target, TermState otherState)
Expert: Seeks a specific position byTermState
previously obtained fromTermsEnum.termState()
.BytesRef
term()
Returns current term.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).-
Methods inherited from class org.apache.lucene.index.BaseTermsEnum
attributes, seekExact
-
-
-
-
Field Detail
-
in
private final IndexInput in
-
state
private final BlockTermState state
-
doOrd
private final boolean doOrd
-
fieldTerm
private final BlockTermsReader.FieldAndTerm fieldTerm
-
indexEnum
private final TermsIndexReaderBase.FieldIndexEnum indexEnum
-
term
private final BytesRefBuilder term
-
indexIsCurrent
private boolean indexIsCurrent
-
didIndexNext
private boolean didIndexNext
-
nextIndexTerm
private BytesRef nextIndexTerm
-
seekPending
private boolean seekPending
-
termSuffixes
private byte[] termSuffixes
-
termSuffixesReader
private ByteArrayDataInput termSuffixesReader
-
termBlockPrefix
private int termBlockPrefix
-
blockTermCount
private int blockTermCount
-
docFreqBytes
private byte[] docFreqBytes
-
freqReader
private final ByteArrayDataInput freqReader
-
metaDataUpto
private int metaDataUpto
-
bytes
private byte[] bytes
-
bytesReader
private ByteArrayDataInput bytesReader
-
-
Method Detail
-
seekCeil
public TermsEnum.SeekStatus seekCeil(BytesRef target) throws java.io.IOException
Description copied from class:TermsEnum
Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.
-
next
public BytesRef next() throws java.io.IOException
Description copied from interface:BytesRefIterator
Increments the iteration to the nextBytesRef
in the iterator. Returns the resultingBytesRef
ornull
if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.- Returns:
- the next
BytesRef
in the iterator ornull
if the end of the iterator is reached. - Throws:
java.io.IOException
- If there is a low-level I/O error.
-
_next
private BytesRef _next() throws java.io.IOException
- Throws:
java.io.IOException
-
term
public BytesRef term()
Description copied from class:TermsEnum
Returns current term. Do not call this when the enum is unpositioned.
-
docFreq
public int docFreq() throws java.io.IOException
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
.
-
totalTermFreq
public long totalTermFreq() throws java.io.IOException
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:
java.io.IOException
-
postings
public PostingsEnum postings(PostingsEnum reuse, int flags) throws java.io.IOException
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:
java.io.IOException
-
impacts
public ImpactsEnum impacts(int flags) throws java.io.IOException
Description copied from class:TermsEnum
Return aImpactsEnum
.- Specified by:
impacts
in classTermsEnum
- Throws:
java.io.IOException
- See Also:
TermsEnum.postings(PostingsEnum, int)
-
seekExact
public void seekExact(BytesRef target, TermState otherState)
Description copied from class:TermsEnum
Expert: Seeks a specific position byTermState
previously obtained fromTermsEnum.termState()
. Callers should maintain theTermState
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 sameTermsEnum
instance.NOTE: Using this method with an incompatible
TermState
might leave thisTermsEnum
in undefined state. On a segment levelTermState
instances are compatible only iff the source and the targetTermsEnum
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 theAttributeSource
's state.AttributeSource
states must be maintained separately if this method is used.- Overrides:
seekExact
in classBaseTermsEnum
- Parameters:
target
- the term the TermState corresponds tootherState
- theTermState
-
termState
public TermState termState() throws java.io.IOException
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:
java.io.IOException
- See Also:
TermState
,TermsEnum.seekExact(BytesRef, TermState)
-
seekExact
public void seekExact(long ord) throws java.io.IOException
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.
-
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.
-
nextBlock
private boolean nextBlock() throws java.io.IOException
- Throws:
java.io.IOException
-
decodeMetaData
private void decodeMetaData() throws java.io.IOException
- Throws:
java.io.IOException
-
-