Class DocIdSetIterator

This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore NO_MORE_DOCS is set to Int32.MaxValue in order to be used as a sentinel object. Implementations of this class are expected to consider as an invalid value.

Inheritance
System.Object
DocIdSetIterator
DocIdSet.AnonymousClassDocIdSet.AnonymousClassDocIdSetIterator
FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator
FilteredDocIdSetIterator
Scorer
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public abstract class DocIdSetIterator : object

Fields

Name Description
NO_MORE_DOCS

When returned by NextDoc(), Advance(Int32) and DocID() it means there are no more docs in the iterator.

Methods

Name Description
Advance(Int32)

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set.

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: certain implemenations may return a different value (each time) if called several times in a row with the same target.

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.

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

DocID()

Returns the following:

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.