Class FilterAtomicReader.FilterDocsAndPositionsEnum

Base class for filtering DocsAndPositionsEnum implementations.

Inheritance
object
DocIdSetIterator
DocsEnum
DocsAndPositionsEnum
FilterAtomicReader.FilterDocsAndPositionsEnum
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class FilterAtomicReader.FilterDocsAndPositionsEnum : DocsAndPositionsEnum

Constructors

FilterDocsAndPositionsEnum(DocsAndPositionsEnum)

Create a new FilterAtomicReader.FilterDocsAndPositionsEnum

Declaration
public FilterDocsAndPositionsEnum(DocsAndPositionsEnum input)
Parameters
Type Name Description
DocsAndPositionsEnum input

the underlying DocsAndPositionsEnum instance.

Fields

m_input

The underlying DocsAndPositionsEnum instance.

Declaration
protected readonly DocsAndPositionsEnum m_input
Field Value
Type Description
DocsAndPositionsEnum

Properties

Attributes

Returns the related attributes.

Declaration
public override AttributeSource Attributes { get; }
Property Value
Type Description
AttributeSource
Overrides

DocID

Returns the following:

@since 2.9

Declaration
public override int DocID { get; }
Property Value
Type Description
int
Overrides

EndOffset

Returns end offset for the current position, or -1 if offsets were not indexed.

Declaration
public override int EndOffset { get; }
Property Value
Type Description
int
Overrides

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

StartOffset

Returns start offset for the current position, or -1 if offsets were not indexed.

Declaration
public override int StartOffset { get; }
Property Value
Type Description
int
Overrides

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

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

GetPayload()

Returns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).

Declaration
public override BytesRef GetPayload()
Returns
Type Description
BytesRef
Overrides

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

NextPosition()

Returns the next position. You should only call this up to Freq times else the behavior is not defined. If positions were not indexed this will return -1; this only happens if offsets were indexed and you passed needsOffset=true when pulling the enum.

Declaration
public override int NextPosition()
Returns
Type Description
int
Overrides