Show / Hide Table of Contents

    Class FilteredDocIdSetIterator

    Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator. See DocIdSetIterator.

    Inheritance
    System.Object
    DocIdSetIterator
    FilteredDocIdSetIterator
    Inherited Members
    DocIdSetIterator.GetEmpty()
    DocIdSetIterator.NO_MORE_DOCS
    DocIdSetIterator.SlowAdvance(Int32)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class FilteredDocIdSetIterator : DocIdSetIterator

    Constructors

    | Improve this Doc View Source

    FilteredDocIdSetIterator(DocIdSetIterator)

    Constructor.

    Declaration
    public FilteredDocIdSetIterator(DocIdSetIterator innerIter)
    Parameters
    Type Name Description
    DocIdSetIterator innerIter

    Underlying DocIdSetIterator.

    Fields

    | Improve this Doc View Source

    m_innerIter

    Declaration
    protected DocIdSetIterator m_innerIter
    Field Value
    Type Description
    DocIdSetIterator

    Properties

    | Improve this Doc View Source

    DocID

    Declaration
    public override int DocID { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    DocIdSetIterator.DocID

    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

    GetCost()

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

    Match(Int32)

    Validation method to determine whether a docid should be in the result set.

    Declaration
    protected abstract bool Match(int doc)
    Parameters
    Type Name Description
    System.Int32 doc

    docid to be tested

    Returns
    Type Description
    System.Boolean

    true if input docid should be in the result set, false otherwise.

    See Also
    FilteredDocIdSetIterator(DocIdSetIterator)
    | Improve this Doc View Source

    NextDoc()

    Declaration
    public override int NextDoc()
    Returns
    Type Description
    System.Int32
    Overrides
    DocIdSetIterator.NextDoc()
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)