abstract class RelativeIterator extends IntervalIterator
Modifier and Type | Field and Description |
---|---|
(package private) IntervalIterator |
a |
(package private) IntervalIterator |
b |
(package private) boolean |
bpos |
NO_MORE_INTERVALS
NO_MORE_DOCS
Constructor and Description |
---|
RelativeIterator(IntervalIterator a,
IntervalIterator b) |
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. |
int |
end()
The end of the current interval
Returns -1 if
IntervalIterator.nextInterval() has not yet been called and IntervalIterator.NO_MORE_INTERVALS
once the iterator is exhausted. |
int |
gaps()
The number of gaps within the current interval
Note that this returns the number of gaps between the immediate sub-intervals
of this interval, and does not include the gaps inside those sub-intervals.
|
float |
matchCost()
An indication of the average cost of iterating over all intervals in a document
|
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 void |
reset() |
int |
start()
The start of the current interval
Returns -1 if
IntervalIterator.nextInterval() has not yet been called and IntervalIterator.NO_MORE_INTERVALS
once the iterator is exhausted. |
nextInterval, toString
all, empty, range, slowAdvance
final IntervalIterator a
final IntervalIterator b
boolean bpos
RelativeIterator(IntervalIterator a, IntervalIterator b)
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 DocIdSetIterator
public int nextDoc() throws java.io.IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class DocIdSetIterator
java.io.IOException
public int advance(int target) throws java.io.IOException
DocIdSetIterator
DocIdSetIterator.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 DocIdSetIterator
java.io.IOException
public long cost()
DocIdSetIterator
DocIdSetIterator
.
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 DocIdSetIterator
protected void reset() throws java.io.IOException
java.io.IOException
public int start()
IntervalIterator
IntervalIterator.nextInterval()
has not yet been called and IntervalIterator.NO_MORE_INTERVALS
once the iterator is exhausted.start
in class IntervalIterator
public int end()
IntervalIterator
IntervalIterator.nextInterval()
has not yet been called and IntervalIterator.NO_MORE_INTERVALS
once the iterator is exhausted.end
in class IntervalIterator
public int gaps()
IntervalIterator
IntervalIterator.nextInterval()
, or after it has returned
IntervalIterator.NO_MORE_INTERVALS
gaps
in class IntervalIterator
public float matchCost()
IntervalIterator
matchCost
in class IntervalIterator
TwoPhaseIterator.matchCost()