Class STMergingTermsEnum
- All Implemented Interfaces:
BytesRefIterator
PostingsEnum
for the same term for a given field from multiple segments. It is
used during segment merging.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
Combines multiple segmentsPostingsEnum
as a singlePostingsEnum
, for one field and one term.Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final String
protected final STMergingTermsEnum.MultiSegmentsPostingsEnum
protected BytesRef
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
STMergingTermsEnum
(String fieldName, int numSegments) Constructs aSTMergingTermsEnum
for a given field. -
Method Summary
Modifier and TypeMethodDescriptionReturns the related attributes.int
docFreq()
Returns the number of documents containing the current term.impacts
(int flags) Return aImpactsEnum
.next()
Increments the iteration to the nextBytesRef
in the iterator.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.protected void
reset
(BytesRef term, List<STUniformSplitTermsWriter.SegmentPostings> segmentPostings) Resets thisSTMergingTermsEnum
with a new term and its list ofSTUniformSplitTermsWriter.SegmentPostings
to combine.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
Expert: Seeks a specific position byTermState
previously obtained fromTermsEnum.termState()
.term()
Returns current term.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
prepareSeekExact, seekExact
-
Field Details
-
fieldName
-
multiPostingsEnum
-
term
-
-
Constructor Details
-
STMergingTermsEnum
Constructs aSTMergingTermsEnum
for a given field.
-
-
Method Details
-
reset
protected void reset(BytesRef term, List<STUniformSplitTermsWriter.SegmentPostings> segmentPostings) Resets thisSTMergingTermsEnum
with a new term and its list ofSTUniformSplitTermsWriter.SegmentPostings
to combine.- Parameters:
segmentPostings
- List sorted by segment index.
-
attributes
Description copied from class:TermsEnum
Returns the related attributes.- Overrides:
attributes
in classBaseTermsEnum
-
seekCeil
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. -
seekExact
public void seekExact(long ord) 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. -
seekExact
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:
term
- the term the TermState corresponds tostate
- theTermState
- Throws:
IOException
-
term
Description copied from class:TermsEnum
Returns current term. Do not call this when the enum is unpositioned. -
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. -
docFreq
public int 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
. -
totalTermFreq
public long 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
-
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
-
impacts
Description copied from class:TermsEnum
Return aImpactsEnum
. -
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
- See Also:
-
next
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.
-