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
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)
System.Object.ToString()
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

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
| Improve this Doc View Source

GetCost()

Declaration
public override long GetCost()
Returns
Type Description
System.Int64
Overrides
| 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
| Improve this Doc View Source

NextDoc()

Declaration
public override int NextDoc()
Returns
Type Description
System.Int32
Overrides