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

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	Description
protected String	fieldName
protected STMergingTermsEnum.MultiSegmentsPostingsEnum	multiPostingsEnum
protected BytesRef	term

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

EMPTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AttributeSource	attributes()
int	docFreq()
ImpactsEnum	impacts(int flags)
BytesRef	next()
long	ord()
PostingsEnum	postings(PostingsEnum reuse, int flags)
protected void	reset(BytesRef term, List<org.apache.lucene.codecs.uniformsplit.sharedterms.STUniformSplitTermsWriter.SegmentPostings> segmentPostings)	Resets this STMergingTermsEnum with a new term and its list of STUniformSplitTermsWriter.SegmentPostings to combine.
TermsEnum.SeekStatus	seekCeil(BytesRef text)
void	seekExact(long ord)
boolean	seekExact(BytesRef text)
void	seekExact(BytesRef term, TermState state)
BytesRef	term()
TermState	termState()
long	totalTermFreq()

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 String fieldName

multiPostingsEnum

protected final STMergingTermsEnum.MultiSegmentsPostingsEnum multiPostingsEnum

term

protected BytesRef term

Constructor Detail

STMergingTermsEnum

protected STMergingTermsEnum(String fieldName,
                             int numSegments)

Constructs a STMergingTermsEnum for a given field.

Method Detail

reset

protected void reset(BytesRef term,
                     List<org.apache.lucene.codecs.uniformsplit.sharedterms.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()

Specified by:

attributes in class TermsEnum

seekExact

public boolean seekExact(BytesRef text)
                  throws IOException

Specified by:

seekExact in class TermsEnum

Throws:

IOException

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef text)

Specified by:

seekCeil in class TermsEnum

seekExact

public void seekExact(long ord)

Specified by:

seekExact in class TermsEnum

seekExact

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

Specified by:

seekExact in class TermsEnum

Throws:

IOException

term

public BytesRef term()

Specified by:

term in class TermsEnum

ord

public long ord()

Specified by:

ord in class TermsEnum

docFreq

public int docFreq()

Specified by:

docFreq in class TermsEnum

totalTermFreq

public long totalTermFreq()

Specified by:

totalTermFreq in class TermsEnum

postings

public PostingsEnum postings(PostingsEnum reuse,
                             int flags)

Specified by:

postings in class TermsEnum

impacts

public ImpactsEnum impacts(int flags)

Specified by:

impacts in class TermsEnum

termState

public TermState termState()

Specified by:

termState in class TermsEnum

next

public BytesRef next()