Class DocIdSetIterator
- Direct Known Subclasses:
BinaryDocValues
,BitSetIterator
,DisjunctionDISIApproximation
,DocBaseBitSetIterator
,FilterDocIdSetIterator
,FilteredDocIdSetIterator
,ImpactsDISI
,IndexedDISI
,KnnVectorValues.DocIndexIterator
,MinDocIterator
,NumericDocValues
,PostingsEnum
,SortedDocValues
,SortedNumericDocValues
,SortedSetDocValues
NO_MORE_DOCS
is set to 2147483647 in order to be used as a sentinel object. Implementations of this class are
expected to consider Integer.MAX_VALUE
as an invalid value.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
When returned bynextDoc()
,advance(int)
anddocID()
it means there are no more docs in the iterator. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract int
advance
(int target) Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.static DocIdSetIterator
all
(int maxDoc) ADocIdSetIterator
that matches all documents up tomaxDoc - 1
.abstract long
cost()
Returns the estimated cost of thisDocIdSetIterator
.abstract int
docID()
int
Returns the end of the run of consecutive doc IDs that match thisDocIdSetIterator
and that contains the currentdocID()
, that is: one plus the last doc ID of the run.static DocIdSetIterator
empty()
An emptyDocIdSetIterator
instancevoid
intoBitSet
(int upTo, FixedBitSet bitSet, int offset) Load doc IDs into aFixedBitSet
.abstract int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orNO_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.static DocIdSetIterator
range
(int minDoc, int maxDoc) ADocIdSetIterator
that matches a range documents from minDocID (inclusive) to maxDocID (exclusive).protected final int
slowAdvance
(int target) Slow (linear) implementation ofadvance(int)
relying onnextDoc()
to advance beyond the target position.
-
Field Details
-
NO_MORE_DOCS
public static final int NO_MORE_DOCSWhen returned bynextDoc()
,advance(int)
anddocID()
it means there are no more docs in the iterator.- See Also:
-
-
Constructor Details
-
DocIdSetIterator
public DocIdSetIterator()
-
-
Method Details
-
empty
An emptyDocIdSetIterator
instance -
all
ADocIdSetIterator
that matches all documents up tomaxDoc - 1
. -
range
ADocIdSetIterator
that matches a range documents from minDocID (inclusive) to maxDocID (exclusive). -
docID
public abstract int docID()Returns the following:-1
ifnextDoc()
oradvance(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
-
nextDoc
Advances to the next document in the set and returns the doc it is currently on, orNO_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.- Throws:
IOException
- Since:
- 2.9
-
advance
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 returnsNO_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.- Throws:
IOException
- Since:
- 2.9
-
slowAdvance
Slow (linear) implementation ofadvance(int)
relying onnextDoc()
to advance beyond the target position.- Throws:
IOException
-
cost
public abstract long cost()Returns the estimated cost of thisDocIdSetIterator
.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.
-
intoBitSet
Load doc IDs into aFixedBitSet
. This should behave exactly as if implemented as below, which is the default implementation:for (int doc = docID(); doc < upTo; doc = nextDoc()) { bitSet.set(doc - offset); }
Note:
offset
must be less than or equal to thecurrent doc ID
. Behaviour is undefined if this iterator is unpositioned.Note: It is important not to clear bits from
bitSet
that may be already set.Note:
offset
may be negative.- Throws:
IOException
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
docIDRunEnd
Returns the end of the run of consecutive doc IDs that match thisDocIdSetIterator
and that contains the currentdocID()
, that is: one plus the last doc ID of the run.- The returned doc is greater than
docID()
. - All docs in range
[docID(), docIDRunEnd())
match this iterator. - The current position of this iterator is not affected by calling
docIDRunEnd()
.
Note: It is illegal to call this method when the iterator is exhausted or not positioned.
The default implementation assumes runs of a single doc ID and returns
docID()
) + 1.- Throws:
IOException
- The returned doc is greater than
-