Package org.apache.lucene.codecs
Class TermsConsumer
java.lang.Object
org.apache.lucene.codecs.TermsConsumer
Abstract API that consumes terms for an individual field.
The lifecycle is:
- TermsConsumer is returned for each field
by
FieldsConsumer.addField(FieldInfo)
. - TermsConsumer returns a
PostingsConsumer
for each term instartTerm(BytesRef)
. - When the producer (e.g. IndexWriter)
is done adding documents for the term, it calls
finishTerm(BytesRef, TermStats)
, passing in the accumulated term statistics. - Producer calls
finish(long, long, int)
with the accumulated collection statistics when it is finished adding terms to the field.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
finish
(long sumTotalTermFreq, long sumDocFreq, int docCount) Called when we are done adding terms to this field.abstract void
finishTerm
(BytesRef text, TermStats stats) Finishes the current term; numDocs must be > 0.abstract Comparator<BytesRef>
Return the BytesRef Comparator used to sort terms before feeding to this API.void
merge
(MergeState mergeState, FieldInfo.IndexOptions indexOptions, TermsEnum termsEnum) Default merge implabstract PostingsConsumer
Starts a new term in this field; this may be called with no corresponding call to finish if the term had no docs.
-
Constructor Details
-
TermsConsumer
protected TermsConsumer()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
startTerm
Starts a new term in this field; this may be called with no corresponding call to finish if the term had no docs.- Throws:
IOException
-
finishTerm
Finishes the current term; numDocs must be > 0.stats.totalTermFreq
will be -1 when term frequencies are omitted for the field.- Throws:
IOException
-
finish
public abstract void finish(long sumTotalTermFreq, long sumDocFreq, int docCount) throws IOException Called when we are done adding terms to this field.sumTotalTermFreq
will be -1 when term frequencies are omitted for the field.- Throws:
IOException
-
getComparator
Return the BytesRef Comparator used to sort terms before feeding to this API.- Throws:
IOException
-
merge
public void merge(MergeState mergeState, FieldInfo.IndexOptions indexOptions, TermsEnum termsEnum) throws IOException Default merge impl- Throws:
IOException
-