public abstract class FilterBinaryDocValues extends BinaryDocValues
BinaryDocValues
.Modifier and Type | Field and Description |
---|---|
protected BinaryDocValues |
in
Wrapped values
|
NO_MORE_DOCS
Modifier | Constructor and Description |
---|---|
protected |
FilterBinaryDocValues(BinaryDocValues in)
Sole constructor
|
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. |
BytesRef |
binaryValue()
Returns the binary value for the current document ID.
|
long |
cost()
Returns the estimated cost of this
DocIdSetIterator . |
int |
docID()
Returns the following:
-1 if DocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) were not called yet. |
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, empty, range, slowAdvance
protected final BinaryDocValues in
protected FilterBinaryDocValues(BinaryDocValues in)
public int docID()
DocIdSetIterator
-1
if DocIdSetIterator.nextDoc()
or
DocIdSetIterator.advance(int)
were not called yet.
DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.
docID
in class DocIdSetIterator
public int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class DocIdSetIterator
IOException
public int advance(int target) throws IOException
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
IOException
public boolean advanceExact(int target) throws IOException
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()
returns target
.IOException
public 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 BytesRef binaryValue() throws IOException
BinaryDocValues
advanceExact(int)
returned false
.binaryValue
in class BinaryDocValues
IOException
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.