public abstract class IntervalFilter extends IntervalIterator
IntervalIterator and passes through those intervals that match the accept() function| Modifier and Type | Field and Description |
|---|---|
protected IntervalIterator |
in |
NO_MORE_INTERVALSNO_MORE_DOCS| Constructor and Description |
|---|
IntervalFilter(IntervalIterator in)
Create a new filter
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract boolean |
accept() |
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 |
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
|
int |
start()
The start of the current interval
Returns -1 if
IntervalIterator.nextInterval() has not yet been called |
toStringall, empty, range, slowAdvanceprotected final IntervalIterator in
public IntervalFilter(IntervalIterator in)
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 DocIdSetIteratorpublic int start()
IntervalIteratorIntervalIterator.nextInterval() has not yet been calledstart in class IntervalIteratorpublic int end()
IntervalIteratorIntervalIterator.nextInterval() has not yet been calledend in class IntervalIteratorpublic float matchCost()
IntervalIteratormatchCost in class IntervalIteratorTwoPhaseIterator.matchCost()protected abstract boolean accept()
true if the wrapped iterator's interval should be passed onpublic final int nextInterval()
throws java.io.IOException
IntervalIteratornextInterval in class IntervalIteratorIntervalIterator.NO_MORE_INTERVALS if
there are no more intervals on the current documentjava.io.IOExceptionCopyright © 2000–2025 The Apache Software Foundation. All rights reserved.