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 the current whose document number is greater
than or equal to target.
|
int |
doc()
Deprecated.
use
docID() instead. |
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.
|
boolean |
next()
Deprecated.
use
nextDoc() instead. |
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: in 3.0 this method will become abstract, following the removal of DocIdSetIterator.next() . |
boolean |
skipTo(int n)
Deprecated.
use
advance(int) instead. |
protected DocIdSetIterator _innerIter
public FilteredDocIdSetIterator(DocIdSetIterator innerIter)
innerIter
- Underlying DocIdSetIterator.protected abstract boolean match(int doc) throws java.io.IOException
doc
- docid to be testedjava.io.IOException
FilteredDocIdSetIterator(DocIdSetIterator).
public final int doc()
docID()
instead.DocIdSetIterator
DocIdSetIterator.docID()
instead. This method throws
UnsupportedOperationException
if called.doc
in class DocIdSetIterator
public int docID()
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if DocIdSetIterator.nextDoc()
or
DocIdSetIterator.advance(int)
were not called yet.
DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.
NOTE: in 3.0, this method will become abstract.
docID
in class DocIdSetIterator
public final boolean next() throws java.io.IOException
nextDoc()
instead.DocIdSetIterator
DocIdSetIterator.nextDoc()
instead. This method throws
UnsupportedOperationException
if called.next
in class DocIdSetIterator
java.io.IOException
public int nextDoc() throws java.io.IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.DocIdSetIterator.next()
. For backward compatibility it is implemented as:
public int nextDoc() throws IOException { return next() ? doc() : NO_MORE_DOCS; }NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
nextDoc
in class DocIdSetIterator
java.io.IOException
public final boolean skipTo(int n) throws java.io.IOException
advance(int)
instead.DocIdSetIterator
DocIdSetIterator.advance(int)
instead. This method throws
UnsupportedOperationException
if called.skipTo
in class DocIdSetIterator
java.io.IOException
public int advance(int target) throws java.io.IOException
DocIdSetIterator
DocIdSetIterator.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: certain implementations may return a different value (each time) if called several times in a row with the same target.
NOTE: this method may be called with 2147483647 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.
NOTE: in 3.0 this method will become abstract, following the removal
of DocIdSetIterator.skipTo(int)
.
advance
in class DocIdSetIterator
java.io.IOException
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.