|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.DocIdSetIterator
public abstract class DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing
doc ids. Note that this class assumes it iterates on doc Ids, and therefore
NO_MORE_DOCS
is set to 2147483647 in order to be used as
a sentinel object. Implementations of this class are expected to consider
Integer.MAX_VALUE
as an invalid value.
Field Summary | |
---|---|
static int |
NO_MORE_DOCS
When returned by nextDoc() , advance(int) and
doc() it means there are no more docs in the iterator. |
Constructor Summary | |
---|---|
DocIdSetIterator()
|
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 NO_MORE_DOCS if nextDoc() or
advance(int) were not called yet. |
boolean |
next()
Deprecated. use nextDoc() instead. This will be removed in 3.0 |
int |
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, or 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 next() . |
boolean |
skipTo(int target)
Deprecated. use advance(int) instead. This will be removed in 3.0 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_MORE_DOCS
nextDoc()
, advance(int)
and
doc()
it means there are no more docs in the iterator.
Constructor Detail |
---|
public DocIdSetIterator()
Method Detail |
---|
public int doc()
docID()
instead.
docID()
instead. This method throws
UnsupportedOperationException
if called.
public int docID()
NO_MORE_DOCS
if nextDoc()
or
advance(int)
were not called yet.
NO_MORE_DOCS
if the iterator has exhausted.
NOTE: in 3.0, this method will become abstract.
public boolean next() throws IOException
nextDoc()
instead. This will be removed in 3.0
nextDoc()
instead. This method throws
UnsupportedOperationException
if called.
IOException
public boolean skipTo(int target) throws IOException
advance(int)
instead. This will be removed in 3.0
advance(int)
instead. This method throws
UnsupportedOperationException
if called.
IOException
public int nextDoc() throws IOException
NO_MORE_DOCS
if there are no more docs in the
set.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.
IOException
public int advance(int target) throws IOException
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 skipTo(int)
.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |