private abstract static class OffsetIntervalsSource.OffsetIntervalIterator extends IntervalIterator
| Modifier and Type | Field and Description |
|---|---|
(package private) IntervalIterator |
in |
NO_MORE_INTERVALSNO_MORE_DOCS| Constructor and Description |
|---|
OffsetIntervalIterator(IntervalIterator in) |
| 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. |
int |
nextInterval()
Advance the iterator to the next interval
|
start, toStringall, empty, range, slowAdvancefinal IntervalIterator in
OffsetIntervalIterator(IntervalIterator in)
public int end()
IntervalIteratorIntervalIterator.nextInterval() has not yet been called and IntervalIterator.NO_MORE_INTERVALS
once the iterator is exhausted.end in class IntervalIteratorpublic int gaps()
IntervalIteratorIntervalIterator.nextInterval(), or after it has returned
IntervalIterator.NO_MORE_INTERVALSgaps in class IntervalIteratorpublic int nextInterval()
throws java.io.IOException
IntervalIteratornextInterval in class IntervalIteratorIntervalIterator.NO_MORE_INTERVALS if
there are no more intervals on the current documentjava.io.IOExceptionpublic float matchCost()
IntervalIteratormatchCost in class IntervalIteratorTwoPhaseIterator.matchCost()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 DocIdSetIteratorpublic int nextDoc()
throws java.io.IOException
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.nextDoc in class DocIdSetIteratorjava.io.IOExceptionpublic int advance(int target)
throws java.io.IOException
DocIdSetIteratorDocIdSetIterator.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 DocIdSetIteratorjava.io.IOExceptionpublic long cost()
DocIdSetIteratorDocIdSetIterator.
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