public class FilterSortedSetDocValues extends SortedSetDocValues
SortedSetDocValues.| Modifier and Type | Field and Description |
|---|---|
protected SortedSetDocValues |
in
Wrapped values
|
NO_MORE_ORDSNO_MORE_DOCS| Constructor and Description |
|---|
FilterSortedSetDocValues(SortedSetDocValues in)
Initializes delegate
|
| 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. |
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. |
long |
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(long ord)
Retrieves the value for the specified ordinal.
|
long |
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. |
long |
nextOrd()
Returns the next ordinal for the current document.
|
TermsEnum |
termsEnum()
Returns a
TermsEnum over the values. |
all, empty, range, slowAdvanceprotected final SortedSetDocValues in
public FilterSortedSetDocValues(SortedSetDocValues 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 long nextOrd()
throws IOException
SortedSetDocValuesadvanceExact(int)
returned false.nextOrd in class SortedSetDocValuesSortedSetDocValues.NO_MORE_ORDS.
ordinals are dense, start at 0, then increment by 1 for
the next value in sorted order.IOExceptionpublic BytesRef lookupOrd(long ord) throws IOException
SortedSetDocValuesBytesRef may be re-used across calls to lookupOrd so make sure to
copy it if you want to keep it
around.lookupOrd in class SortedSetDocValuesord - ordinal to lookupIOExceptionSortedSetDocValues.nextOrd()public long getValueCount()
SortedSetDocValuesgetValueCount in class SortedSetDocValuespublic long lookupTerm(BytesRef key) throws IOException
SortedSetDocValueskey exists, returns its ordinal, else
returns -insertionPoint-1, like Arrays.binarySearch.lookupTerm in class SortedSetDocValueskey - Key to look upIOExceptionpublic TermsEnum termsEnum() throws IOException
SortedSetDocValuesTermsEnum over the values.
The enum supports TermsEnum.ord() and TermsEnum.seekExact(long).termsEnum in class SortedSetDocValuesIOExceptionpublic TermsEnum intersect(CompiledAutomaton automaton) throws IOException
SortedSetDocValuesTermsEnum over the values, filtered by a CompiledAutomaton
The enum supports TermsEnum.ord().intersect in class SortedSetDocValuesIOExceptionpublic 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.