Show / Hide Table of Contents

    Class MultiTermsEnum

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

    This is a Lucene.NET EXPERIMENTAL API, use at your own risk
    Inheritance
    System.Object
    TermsEnum
    MultiTermsEnum
    Implements
    IBytesRefIterator
    Inherited Members
    TermsEnum.Attributes
    TermsEnum.SeekExact(BytesRef, TermState)
    TermsEnum.Docs(IBits, DocsEnum)
    TermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum)
    TermsEnum.GetTermState()
    TermsEnum.EMPTY
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class MultiTermsEnum : TermsEnum, 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
    IComparer<BytesRef>
    Overrides
    TermsEnum.Comparer
    | Improve this Doc View Source

    DocFreq

    Declaration
    public override int DocFreq { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    TermsEnum.DocFreq
    | 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
    MatchArray
    | Improve this Doc View Source

    Ord

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

    Term

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

    TotalTermFreq

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

    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
    TermsEnum.Docs(IBits, DocsEnum, DocsFlags)
    | 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
    TermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)
    | Improve this Doc View Source

    Next()

    Declaration
    public override BytesRef Next()
    Returns
    Type Description
    BytesRef
    Overrides
    TermsEnum.Next()
    | Improve this Doc View Source

    Reset(MultiTermsEnum.TermsEnumIndex[])

    The terms array must be newly created TermsEnum, ie Next() 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
    TermsEnum.SeekCeil(BytesRef)
    | 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
    TermsEnum.SeekExact(BytesRef)
    | Improve this Doc View Source

    SeekExact(Int64)

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

    ToString()

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

    Implements

    IBytesRefIterator
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)