Class FilterAtomicReader.FilterDocsEnum

Base class for filtering DocsEnum implementations.

Inheritance

object

DocIdSetIterator

DocsEnum

FilterAtomicReader.FilterDocsEnum

Inherited Members

DocIdSetIterator.GetEmpty()

DocIdSetIterator.NO_MORE_DOCS

DocIdSetIterator.SlowAdvance(int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public class FilterAtomicReader.FilterDocsEnum : DocsEnum

Constructors

FilterDocsEnum(DocsEnum)

Create a new FilterAtomicReader.FilterDocsEnum

Declaration

public FilterDocsEnum(DocsEnum input)

Parameters

Type	Name	Description
DocsEnum	input	the underlying DocsEnum instance.

Fields

m_input

The underlying DocsEnum instance.

Declaration

protected DocsEnum m_input

Field Value

Type	Description
DocsEnum

Properties

Attributes

Returns the related attributes.

Declaration

public override AttributeSource Attributes { get; }

Property Value

Type	Description
AttributeSource

Overrides

DocsEnum.Attributes

DocID

Returns the following:

• -1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet.
• NO_MORE_DOCS if the iterator has exhausted.
• Otherwise it should return the doc ID it is currently on.

@since 2.9

Declaration

public override int DocID { get; }

Property Value

Type	Description
int

Overrides

DocIdSetIterator.DocID

Freq

Returns term frequency in the current document, or 1 if the field was indexed with DOCS_ONLY. Do not call this before NextDoc() is first called, nor after NextDoc() returns NO_MORE_DOCS.

NOTE: if the DocsEnum was obtain with NONE, the result of this method is undefined.

Declaration

public override int Freq { get; }

Property Value

Type	Description
int

Overrides

DocsEnum.Freq

Methods

Advance(int)

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target <= current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it behaves as if written:

int Advance(int target) 
{
    int doc;
    while ((doc = NextDoc()) < target) 
    {
    }
    return doc;
}

Some implementations are considerably more efficient than that.

NOTE: this method may be called with NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

@since 2.9

Declaration

public override int Advance(int target)

Parameters

Type	Name	Description
int	target

Returns

Type	Description
int

Overrides

DocIdSetIterator.Advance(int)

GetCost()

Returns the estimated cost of this DocIdSetIterator.

This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

Declaration

public override long GetCost()

Returns

Type	Description
long

Overrides

DocIdSetIterator.GetCost()

NextDoc()

Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

@since 2.9

Declaration

public override int NextDoc()

Returns

Type	Description
int

Overrides

DocIdSetIterator.NextDoc()