public abstract class FilterSortedDocValues extends SortedDocValues
SortedDocValues.| Modifier and Type | Field and Description |
|---|---|
protected SortedDocValues |
in
Wrapped values
|
NO_MORE_DOCS| Constructor and Description |
|---|
FilterSortedDocValues(SortedDocValues in)
Sole constructor
|
| 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.
|
boolean |
advanceExact(int target)
Advance the iterator to exactly
target and return whether
target has a value. |
BytesRef |
binaryValue()
Returns the binary value for the current document ID.
|
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 |
getValueCount()
Returns the number of unique values.
|
TermsEnum |
intersect(CompiledAutomaton automaton)
Returns a
TermsEnum over the values, filtered by a CompiledAutomaton
The enum supports TermsEnum.ord(). |
BytesRef |
lookupOrd(int ord)
Retrieves the value for the specified ordinal.
|
int |
lookupTerm(BytesRef key)
If
key exists, returns its ordinal, else
returns -insertionPoint-1, like Arrays.binarySearch. |
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 |
ordValue()
Returns the ordinal for the current docID.
|
TermsEnum |
termsEnum()
Returns a
TermsEnum over the values. |
all, empty, range, slowAdvanceprotected final SortedDocValues in
public FilterSortedDocValues(SortedDocValues in)
public boolean advanceExact(int target)
throws IOException
target and return whether
target has a value.
target must be greater than or equal to the current
doc ID and must be a valid doc ID, ie. ≥ 0 and
< maxDoc.
After this method returns, DocIdSetIterator.docID() returns target.IOExceptionpublic int ordValue()
throws IOException
SortedDocValuesadvanceExact(int)
returned false.ordValue in class SortedDocValuesIOExceptionpublic BytesRef lookupOrd(int ord) throws IOException
SortedDocValuesBytesRef may be re-used across calls to SortedDocValues.lookupOrd(int)
so make sure to copy it if you want
to keep it around.lookupOrd in class SortedDocValuesord - ordinal to lookup (must be >= 0 and < SortedDocValues.getValueCount())IOExceptionSortedDocValues.ordValue()public BytesRef binaryValue() throws IOException
BinaryDocValuesadvanceExact(int)
returned false.binaryValue in class SortedDocValuesIOExceptionpublic int getValueCount()
SortedDocValuesgetValueCount in class SortedDocValuespublic int lookupTerm(BytesRef key) throws IOException
SortedDocValueskey exists, returns its ordinal, else
returns -insertionPoint-1, like Arrays.binarySearch.lookupTerm in class SortedDocValueskey - Key to look upIOExceptionpublic TermsEnum termsEnum() throws IOException
SortedDocValuesTermsEnum over the values.
The enum supports TermsEnum.ord() and TermsEnum.seekExact(long).termsEnum in class SortedDocValuesIOExceptionpublic TermsEnum intersect(CompiledAutomaton automaton) throws IOException
SortedDocValuesTermsEnum over the values, filtered by a CompiledAutomaton
The enum supports TermsEnum.ord().intersect in class SortedDocValuesIOExceptionpublic 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 IOException
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.nextDoc in class DocIdSetIteratorIOExceptionpublic int advance(int target)
throws 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 DocIdSetIteratorIOExceptionpublic 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 DocIdSetIteratorCopyright © 2000-2021 Apache Software Foundation. All Rights Reserved.