public class BitSetIterator extends DocIdSetIterator
DocIdSetIterator which iterates over set bits in a
bit set.NO_MORE_DOCS| Constructor and Description |
|---|
BitSetIterator(BitSet bits,
long cost)
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.
|
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. |
static FixedBitSet |
getFixedBitSetOrNull(DocIdSetIterator iterator)
If the provided iterator wraps a
FixedBitSet, returns it, otherwise returns null. |
static SparseFixedBitSet |
getSparseFixedBitSetOrNull(DocIdSetIterator iterator)
If the provided iterator wraps a
SparseFixedBitSet, returns it, otherwise returns null. |
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, slowAdvancepublic BitSetIterator(BitSet bits, long cost)
public static FixedBitSet getFixedBitSetOrNull(DocIdSetIterator iterator)
FixedBitSet, returns it, otherwise returns null.public static SparseFixedBitSet getSparseFixedBitSetOrNull(DocIdSetIterator iterator)
SparseFixedBitSet, returns it, otherwise returns null.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 DocIdSetIteratorpublic int nextDoc()
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.nextDoc in class DocIdSetIteratorpublic int advance(int target)
DocIdSetIteratorDocIdSetIterator.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 DocIdSetIteratorpublic long cost()
DocIdSetIteratorDocIdSetIterator.
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 DocIdSetIteratorCopyright © 2000-2016 Apache Software Foundation. All Rights Reserved.