org.apache.lucene.codecs.uniformsplit.sharedterms

Class STMergingTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.codecs.uniformsplit.sharedterms.STMergingTermsEnum

All Implemented Interfaces:

BytesRefIterator

public class STMergingTermsEnum
extends TermsEnum

Combines PostingsEnum for the same term for a given field from multiple segments. It is used during segment merging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	STMergingTermsEnum.MultiSegmentsPostingsEnum Combines multiple segments PostingsEnum as a single PostingsEnum, for one field and one term.

Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	fieldName
protected STMergingTermsEnum.MultiSegmentsPostingsEnum	multiPostingsEnum
protected BytesRef	term

Fields inherited from class org.apache.lucene.index.TermsEnum

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	STMergingTermsEnum(java.lang.String fieldName, int numSegments) Constructs a STMergingTermsEnum for a given field.

Method Summary

Modifier and Type	Method and Description
AttributeSource	attributes() Returns the related attributes.
int	docFreq() Returns the number of documents containing the current term.
ImpactsEnum	impacts(int flags) Return a ImpactsEnum.
BytesRef	next() Increments the iteration to the next BytesRef in the iterator.
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.
protected void	reset(BytesRef term, java.util.List<STUniformSplitTermsWriter.SegmentPostings> segmentPostings) Resets this STMergingTermsEnum with a new term and its list of STUniformSplitTermsWriter.SegmentPostings to combine.
TermsEnum.SeekStatus	seekCeil(BytesRef text) Seeks to the specified term, if it exists, or to the next (ceiling) term.
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().
void	seekExact(long ord) Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord().
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.TermsEnum

postings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fieldName

protected final java.lang.String fieldName

multiPostingsEnum

protected final STMergingTermsEnum.MultiSegmentsPostingsEnum multiPostingsEnum

term

protected BytesRef term

Constructor Detail

STMergingTermsEnum

protected STMergingTermsEnum(java.lang.String fieldName,
                             int numSegments)

Constructs a STMergingTermsEnum for a given field.

Method Detail

reset

protected void reset(BytesRef term,
                     java.util.List<STUniformSplitTermsWriter.SegmentPostings> segmentPostings)

Resets this STMergingTermsEnum with a new term and its list of STUniformSplitTermsWriter.SegmentPostings to combine.

Parameters:

segmentPostings - List sorted by segment index.

attributes

public AttributeSource attributes()

Description copied from class: TermsEnum

Returns the related attributes.

Specified by:

attributes in class TermsEnum

seekExact

public boolean seekExact(BytesRef text)
                  throws java.io.IOException

Description copied from class: TermsEnum

Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster than TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Specified by:

seekExact in class TermsEnum

Returns:

true if the term is found; return false if the enum is unpositioned.

Throws:

java.io.IOException

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef text)

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.

Specified by:

seekCeil in class TermsEnum

seekExact

public void seekExact(long ord)

Description copied from class: TermsEnum

Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.

Specified by:

seekExact in class TermsEnum

seekExact

public void seekExact(BytesRef term,
                      TermState state)
               throws java.io.IOException

Description copied from class: TermsEnum

Expert: Seeks a specific position by 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.

Specified by:

seekExact in class TermsEnum

Parameters:

term - the term the TermState corresponds to

state - the TermState

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.

Specified by:

term in class TermsEnum

ord

public long ord()

Description copied from class: TermsEnum

Returns ordinal position for current term. This is an optional method (the codec may throw UnsupportedOperationException). Do not call this when the enum is unpositioned.

Specified by:

ord in class TermsEnum

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.

Specified by:

docFreq in class TermsEnum

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 class TermsEnum

postings

public PostingsEnum postings(PostingsEnum reuse,
                             int flags)

Description copied from class: TermsEnum

Get 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.

Specified by:

postings in class TermsEnum

Parameters:

reuse - pass a prior PostingsEnum for possible reuse

flags - specifies which optional per-document values you require; see PostingsEnum.FREQS

impacts

public ImpactsEnum impacts(int flags)

Description copied from class: TermsEnum

Return a ImpactsEnum.

Specified by:

impacts in class TermsEnum

See Also:

TermsEnum.postings(PostingsEnum, int)

termState

public TermState 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 the AttributeSource's state. Callers must maintain the AttributeSource states separately

Specified by:

termState in class TermsEnum

See Also:

TermState, TermsEnum.seekExact(BytesRef, TermState)

next

public BytesRef next()

Description copied from interface: BytesRefIterator

Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null 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 or null if the end of the iterator is reached.