Show / Hide Table of Contents

    Class MultiDocsEnum

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

    This is a Lucene.NET EXPERIMENTAL API, use at your own risk
    Inheritance
    System.Object
    DocIdSetIterator
    DocsEnum
    MultiDocsEnum
    Inherited Members
    DocsEnum.Attributes
    DocIdSetIterator.GetEmpty()
    DocIdSetIterator.NO_MORE_DOCS
    DocIdSetIterator.SlowAdvance(Int32)
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class MultiDocsEnum : DocsEnum

    Constructors

    | Improve this Doc View Source

    MultiDocsEnum(MultiTermsEnum, Int32)

    Sole constructor

    Declaration
    public MultiDocsEnum(MultiTermsEnum parent, int subReaderCount)
    Parameters
    Type Name Description
    MultiTermsEnum parent

    The MultiTermsEnum that created us.

    System.Int32 subReaderCount

    How many sub-readers are being merged.

    Properties

    | Improve this Doc View Source

    DocID

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

    Freq

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

    NumSubs

    How many sub-readers we are merging.

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

    Subs

    Returns sub-readers we are merging.

    Declaration
    public MultiDocsEnum.EnumWithSlice[] Subs { get; }
    Property Value
    Type Description
    MultiDocsEnum.EnumWithSlice[]

    Methods

    | Improve this Doc View Source

    Advance(Int32)

    Declaration
    public override int Advance(int target)
    Parameters
    Type Name Description
    System.Int32 target
    Returns
    Type Description
    System.Int32
    Overrides
    DocIdSetIterator.Advance(Int32)
    | Improve this Doc View Source

    CanReuse(MultiTermsEnum)

    Returns true if this instance can be reused by the provided MultiTermsEnum.

    Declaration
    public bool CanReuse(MultiTermsEnum parent)
    Parameters
    Type Name Description
    MultiTermsEnum parent
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    GetCost()

    Declaration
    public override long GetCost()
    Returns
    Type Description
    System.Int64
    Overrides
    DocIdSetIterator.GetCost()
    | Improve this Doc View Source

    NextDoc()

    Declaration
    public override int NextDoc()
    Returns
    Type Description
    System.Int32
    Overrides
    DocIdSetIterator.NextDoc()
    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)