Package org.apache.lucene.index
Class MultiTerms
- java.lang.Object
-
- org.apache.lucene.index.Terms
-
- org.apache.lucene.index.MultiTerms
-
public final class MultiTerms extends Terms
Exposes flex API, merged from flex API of sub-segments.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Constructor Description MultiTerms(Terms[] subs, ReaderSlice[] subSlices)
Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Comparator<BytesRef>
getComparator()
Return the BytesRef Comparator used to sort terms provided by the iterator.int
getDocCount()
Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec.long
getSumDocFreq()
Returns the sum ofTermsEnum.docFreq()
for all terms in this field, or -1 if this measure isn't stored by the codec.long
getSumTotalTermFreq()
Returns the sum ofTermsEnum.totalTermFreq()
for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions).boolean
hasFreqs()
Returns true if documents in this field store per-document term frequency (DocsEnum.freq()
).boolean
hasOffsets()
Returns true if documents in this field store offsets.boolean
hasPayloads()
Returns true if documents in this field store payloads.boolean
hasPositions()
Returns true if documents in this field store positions.TermsEnum
intersect(CompiledAutomaton compiled, BytesRef startTerm)
Returns a TermsEnum that iterates over all terms that are accepted by the providedCompiledAutomaton
.TermsEnum
iterator(TermsEnum reuse)
Returns an iterator that will step through all terms.long
size()
Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.
-
-
-
Constructor Detail
-
MultiTerms
public MultiTerms(Terms[] subs, ReaderSlice[] subSlices) throws java.io.IOException
Sole constructor.- Parameters:
subs
- TheTerms
instances of all sub-readers.subSlices
- A parallel array (matchingsubs
) describing the sub-reader slices.- Throws:
java.io.IOException
-
-
Method Detail
-
intersect
public TermsEnum intersect(CompiledAutomaton compiled, BytesRef startTerm) throws java.io.IOException
Description copied from class:Terms
Returns a TermsEnum that iterates over all terms that are accepted by the providedCompiledAutomaton
. If thestartTerm
is provided then the returned enum will only accept terms >startTerm
, but you still must call next() first to get to the first term. Note that the providedstartTerm
must be accepted by the automaton.NOTE: the returned TermsEnum cannot seek
.
-
iterator
public TermsEnum iterator(TermsEnum reuse) throws java.io.IOException
Description copied from class:Terms
Returns an iterator that will step through all terms. This method will not return null. If you have a previous TermsEnum, for example from a different field, you can pass it for possible reuse if the implementation can do so.
-
size
public long size()
Description copied from class:Terms
Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.
-
getSumTotalTermFreq
public long getSumTotalTermFreq() throws java.io.IOException
Description copied from class:Terms
Returns the sum ofTermsEnum.totalTermFreq()
for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions). Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
getSumTotalTermFreq
in classTerms
- Throws:
java.io.IOException
-
getSumDocFreq
public long getSumDocFreq() throws java.io.IOException
Description copied from class:Terms
Returns the sum ofTermsEnum.docFreq()
for all terms in this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
getSumDocFreq
in classTerms
- Throws:
java.io.IOException
-
getDocCount
public int getDocCount() throws java.io.IOException
Description copied from class:Terms
Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
getDocCount
in classTerms
- Throws:
java.io.IOException
-
getComparator
public java.util.Comparator<BytesRef> getComparator()
Description copied from class:Terms
Return the BytesRef Comparator used to sort terms provided by the iterator. This method may return null if there are no terms. This method may be invoked many times; it's best to cache a single instance & reuse it.- Specified by:
getComparator
in classTerms
-
hasFreqs
public boolean hasFreqs()
Description copied from class:Terms
Returns true if documents in this field store per-document term frequency (DocsEnum.freq()
).
-
hasOffsets
public boolean hasOffsets()
Description copied from class:Terms
Returns true if documents in this field store offsets.- Specified by:
hasOffsets
in classTerms
-
hasPositions
public boolean hasPositions()
Description copied from class:Terms
Returns true if documents in this field store positions.- Specified by:
hasPositions
in classTerms
-
hasPayloads
public boolean hasPayloads()
Description copied from class:Terms
Returns true if documents in this field store payloads.- Specified by:
hasPayloads
in classTerms
-
-