Class MultiTermsEnum

Exposes TermsEnum API, merged from TermsEnum API of sub-segments. This does a merge sort, by term text, of the sub-readers.

Note

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

Inheritance
System.Object
TermsEnum
MultiTermsEnum
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public sealed class MultiTermsEnum : TermsEnum, IBytesRefEnumerator, IBytesRefIterator

Constructors

| Improve this Doc View Source

MultiTermsEnum(ReaderSlice[])

Sole constructor.

Declaration
public MultiTermsEnum(ReaderSlice[] slices)
Parameters
Type Name Description
ReaderSlice[] slices

Which sub-reader slices we should merge.

Properties

| Improve this Doc View Source

Comparer

Declaration
public override IComparer<BytesRef> Comparer { get; }
Property Value
Type Description
System.Collections.Generic.IComparer<BytesRef>
Overrides
| Improve this Doc View Source

DocFreq

Declaration
public override int DocFreq { get; }
Property Value
Type Description
System.Int32
Overrides
| Improve this Doc View Source

MatchArray

Returns sub-reader slices positioned to the current term.

Declaration
public MultiTermsEnum.TermsEnumWithSlice[] MatchArray { get; }
Property Value
Type Description
MultiTermsEnum.TermsEnumWithSlice[]
| Improve this Doc View Source

MatchCount

Returns how many sub-reader slices contain the current term.

Declaration
public int MatchCount { get; }
Property Value
Type Description
System.Int32
See Also
| Improve this Doc View Source

Ord

Declaration
public override long Ord { get; }
Property Value
Type Description
System.Int64
Overrides
| Improve this Doc View Source

Term

Declaration
public override BytesRef Term { get; }
Property Value
Type Description
BytesRef
Overrides
| Improve this Doc View Source

TotalTermFreq

Declaration
public override long TotalTermFreq { get; }
Property Value
Type Description
System.Int64
Overrides

Methods

| Improve this Doc View Source

Docs(IBits, DocsEnum, DocsFlags)

Declaration
public override DocsEnum Docs(IBits liveDocs, DocsEnum reuse, DocsFlags flags)
Parameters
Type Name Description
IBits liveDocs
DocsEnum reuse
DocsFlags flags
Returns
Type Description
DocsEnum
Overrides
| Improve this Doc View Source

DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)

Declaration
public override DocsAndPositionsEnum DocsAndPositions(IBits liveDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)
Parameters
Type Name Description
IBits liveDocs
DocsAndPositionsEnum reuse
DocsAndPositionsFlags flags
Returns
Type Description
DocsAndPositionsEnum
Overrides
| Improve this Doc View Source

MoveNext()

Declaration
public override bool MoveNext()
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

Reset(MultiTermsEnum.TermsEnumIndex[])

The terms array must be newly created TermsEnum, ie MoveNext() has not yet been called.

Declaration
public TermsEnum Reset(MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex)
Parameters
Type Name Description
MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex
Returns
Type Description
TermsEnum
| Improve this Doc View Source

SeekCeil(BytesRef)

Declaration
public override TermsEnum.SeekStatus SeekCeil(BytesRef term)
Parameters
Type Name Description
BytesRef term
Returns
Type Description
TermsEnum.SeekStatus
Overrides
| Improve this Doc View Source

SeekExact(BytesRef)

Declaration
public override bool SeekExact(BytesRef term)
Parameters
Type Name Description
BytesRef term
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

SeekExact(Int64)

Declaration
public override void SeekExact(long ord)
Parameters
Type Name Description
System.Int64 ord
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Implements