public abstract class FilteredDocIdSetIterator extends DocIdSetIterator
FilteredDocIdSet.| Modifier and Type | Field and Description |
|---|---|
protected DocIdSetIterator |
_innerIter |
NO_MORE_DOCS| Constructor and Description |
|---|
FilteredDocIdSetIterator(DocIdSetIterator innerIter)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
int |
advance(int target)
Advances to the first beyond (see NOTE below) the current whose document
number is greater than or equal to target.
|
int |
docID()
Returns the following:
-1 or
DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) were not called yet. |
protected abstract boolean |
match(int doc)
Validation method to determine whether a docid should be in the result set.
|
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. |
protected DocIdSetIterator _innerIter
public FilteredDocIdSetIterator(DocIdSetIterator innerIter)
innerIter - Underlying DocIdSetIterator.protected abstract boolean match(int doc)
throws IOException
doc - docid to be testedIOExceptionFilteredDocIdSetIterator(DocIdSetIterator)public int docID()
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS 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()
throws IOException
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.nextDoc in class DocIdSetIteratorIOExceptionpublic int advance(int target)
throws IOException
DocIdSetIteratorDocIdSetIterator.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: when target ≤ current implementations may opt
not to advance beyond their current DocIdSetIterator.docID().
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.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
advance in class DocIdSetIteratorIOExceptionCopyright © 2000-2015 Apache Software Foundation. All Rights Reserved.