Class MultiTerms

Exposes flex API, merged from flex API of sub-segments.

Note

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

Inheritance
object
Terms
MultiTerms
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public sealed class MultiTerms : Terms

Constructors

MultiTerms(Terms[], ReaderSlice[])

Sole constructor.

Declaration
public MultiTerms(Terms[] subs, ReaderSlice[] subSlices)
Parameters
Type Name Description
Terms[] subs

The Terms instances of all sub-readers.
ReaderSlice[] subSlices

A parallel array (matching subs) describing the sub-reader slices.

Properties

Comparer

Return the IComparer{BytesRef} 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.

Declaration
public override IComparer<BytesRef> Comparer { get; }
Property Value
Type Description
IComparer<BytesRef>
Overrides

Count

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. NOTE: This was size() in Lucene.

Declaration
public override long Count { get; }
Property Value
Type Description
long
Overrides

DocCount

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.

Declaration
public override int DocCount { get; }
Property Value
Type Description
int
Overrides

HasFreqs

Returns true if documents in this field store per-document term frequency (Freq).

Declaration
public override bool HasFreqs { get; }
Property Value
Type Description
bool
Overrides

HasOffsets

Returns true if documents in this field store offsets.

Declaration
public override bool HasOffsets { get; }
Property Value
Type Description
bool
Overrides

HasPayloads

Returns true if documents in this field store payloads.

Declaration
public override bool HasPayloads { get; }
Property Value
Type Description
bool
Overrides

HasPositions

Returns true if documents in this field store positions.

Declaration
public override bool HasPositions { get; }
Property Value
Type Description
bool
Overrides

SumDocFreq

Returns the sum of 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.

Declaration
public override long SumDocFreq { get; }
Property Value
Type Description
long
Overrides

SumTotalTermFreq

Returns the sum of 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.

Declaration
public override long SumTotalTermFreq { get; }
Property Value
Type Description
long
Overrides

Methods

GetEnumerator()

Returns an iterator that will step through all terms. This method will not return null.

Declaration
public override TermsEnum GetEnumerator()
Returns
Type Description
TermsEnum
Overrides

Intersect(CompiledAutomaton, BytesRef)

Returns a TermsEnum that iterates over all terms that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only accept terms

startTerm, but you still must call MoveNext() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

NOTE: the returned TermsEnum cannot seek

.
Declaration
public override TermsEnum Intersect(CompiledAutomaton compiled, BytesRef startTerm)
Parameters
Type Name Description
CompiledAutomaton compiled
BytesRef startTerm
Returns
Type Description
TermsEnum
Overrides