|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.DocIdSetIterator org.apache.lucene.search.FilteredDocIdSetIterator
public abstract class FilteredDocIdSetIterator
Abstract decorator class of a DocIdSetIterator
implementation that provides on-demand filter/validation
mechanism on an underlying DocIdSetIterator. See FilteredDocIdSet
.
Field Summary | |
---|---|
protected DocIdSetIterator |
_innerIter
|
Fields inherited from class org.apache.lucene.search.DocIdSetIterator |
---|
NO_MORE_DOCS |
Constructor Summary | |
---|---|
FilteredDocIdSetIterator(DocIdSetIterator innerIter)
Constructor. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected DocIdSetIterator _innerIter
Constructor Detail |
---|
public FilteredDocIdSetIterator(DocIdSetIterator innerIter)
innerIter
- Underlying DocIdSetIterator.Method Detail |
---|
protected abstract boolean match(int doc) throws IOException
doc
- docid to be tested
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 IOException
nextDoc()
instead.
DocIdSetIterator
DocIdSetIterator.nextDoc()
instead. This method throws
UnsupportedOperationException
if called.
next
in class DocIdSetIterator
IOException
public int nextDoc() throws 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
IOException
public final boolean skipTo(int n) throws IOException
advance(int)
instead.
DocIdSetIterator
DocIdSetIterator.advance(int)
instead. This method throws
UnsupportedOperationException
if called.
skipTo
in class DocIdSetIterator
IOException
public int advance(int target) throws 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
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |