abstract static class DocValuesFieldUpdates.Iterator extends DocValuesIterator
NO_MORE_DOCS
Constructor and Description |
---|
Iterator() |
Modifier and Type | Method and Description |
---|---|
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.
|
boolean |
advanceExact(int target)
Advance the iterator to exactly
target and return whether
target has a value. |
(package private) static BinaryDocValues |
asBinaryDocValues(DocValuesFieldUpdates.Iterator iterator)
Wraps the given iterator as a BinaryDocValues instance.
|
(package private) static NumericDocValues |
asNumericDocValues(DocValuesFieldUpdates.Iterator iterator)
Wraps the given iterator as a NumericDocValues instance.
|
(package private) abstract BytesRef |
binaryValue()
Returns a binary value for the current document if this iterator is a binary value iterator.
|
long |
cost()
Returns the estimated cost of this
DocIdSetIterator . |
(package private) abstract long |
delGen()
Returns delGen for this packet.
|
(package private) abstract boolean |
hasValue()
Returns true if this doc has a value
|
(package private) abstract long |
longValue()
Returns a long value for the current document if this iterator is a long iterator.
|
abstract int |
nextDoc()
Advances to the next document in the set and returns the doc it is
currently on, or
DocIdSetIterator.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. |
all, docID, empty, range, slowAdvance
public final boolean advanceExact(int target)
DocValuesIterator
target
and return whether
target
has a value.
target
must be greater than or equal to the current
doc ID
and must be a valid doc ID, ie. ≥ 0 and
< maxDoc
.
After this method returns, DocIdSetIterator.docID()
retuns target
.advanceExact
in class DocValuesIterator
public final int advance(int target)
DocIdSetIterator
DocIdSetIterator.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 DocIdSetIterator.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.
advance
in class DocIdSetIterator
public final long cost()
DocIdSetIterator
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.
cost
in class DocIdSetIterator
public abstract int nextDoc()
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class DocIdSetIterator
abstract long longValue()
abstract BytesRef binaryValue()
abstract long delGen()
abstract boolean hasValue()
static BinaryDocValues asBinaryDocValues(DocValuesFieldUpdates.Iterator iterator)
static NumericDocValues asNumericDocValues(DocValuesFieldUpdates.Iterator iterator)