Module org.apache.lucene.facet
Package org.apache.lucene.facet.taxonomy
Class BackCompatSortedNumericDocValues
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.DocValuesIterator
org.apache.lucene.index.SortedNumericDocValues
org.apache.lucene.facet.taxonomy.BackCompatSortedNumericDocValues
Deprecated.
Only here for back-compat support. Should be removed with Lucene 10.
Wraps a
BinaryDocValues
instance, providing a SortedNumericDocValues
interface
for the purpose of being backwards-compatible. (see: LUCENE-10062)-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final BinaryDocValues
Deprecated.private final BiConsumer
<BytesRef, IntsRef> Deprecated.private int
Deprecated.private final IntsRef
Deprecated.Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
BackCompatSortedNumericDocValues
(BinaryDocValues binaryDocValues, BiConsumer<BytesRef, IntsRef> binaryValueDecoder) Deprecated.see the staticwrap
methods -
Method Summary
Modifier and TypeMethodDescriptionint
advance
(int target) Deprecated.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) Deprecated.Advance the iterator to exactlytarget
and return whethertarget
has a value.long
cost()
Deprecated.Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Deprecated.Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
Deprecated.Retrieves the number of values for the current document.(package private) static void
loadValues
(BytesRef buf, IntsRef ordinals) Deprecated.Load ordinals for the currently-positioned doc, assuming the default binary encoding.int
nextDoc()
Deprecated.Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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
Deprecated.Iterates to the next value in the current document.private void
Deprecated.static SortedNumericDocValues
wrap
(BinaryDocValues binaryDocValues, BiConsumer<BytesRef, IntsRef> binaryValueDecoder) Deprecated.Wrap the provided binary encoded doc values.Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
binaryDocValues
Deprecated. -
binaryValueDecoder
Deprecated. -
scratch
Deprecated. -
curr
private int currDeprecated.
-
-
Constructor Details
-
BackCompatSortedNumericDocValues
private BackCompatSortedNumericDocValues(BinaryDocValues binaryDocValues, BiConsumer<BytesRef, IntsRef> binaryValueDecoder) Deprecated.see the staticwrap
methods
-
-
Method Details
-
wrap
public static SortedNumericDocValues wrap(BinaryDocValues binaryDocValues, BiConsumer<BytesRef, IntsRef> binaryValueDecoder) Deprecated.Wrap the provided binary encoded doc values. Decodes the binary values with the providedbinaryValueDecoder
, allowing the default decoding behavior to be overridden. If a null doc values instance is provided, the returned instance will also be null. If a null value decoder is specified, the default encoding will be assumed. -
advanceExact
Deprecated.Description copied from class:DocValuesIterator
Advance the iterator to exactlytarget
and return whethertarget
has a value.target
must be greater than or equal to the currentdoc ID
and must be a valid doc ID, ie. ≥ 0 and <maxDoc
. After this method returns,DocIdSetIterator.docID()
returnstarget
.- Specified by:
advanceExact
in classDocValuesIterator
- Throws:
IOException
-
nextValue
Deprecated.Description copied from class:SortedNumericDocValues
Iterates to the next value in the current document. Do not call this more thanSortedNumericDocValues.docValueCount()
times for the document.- Specified by:
nextValue
in classSortedNumericDocValues
- Throws:
IOException
-
docValueCount
public int docValueCount()Deprecated.Description copied from class:SortedNumericDocValues
Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method afterDocValuesIterator.advanceExact(int)
returnedfalse
.- Specified by:
docValueCount
in classSortedNumericDocValues
-
docID
public int docID()Deprecated.Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
-
nextDoc
Deprecated.Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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.- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
IOException
-
advance
Deprecated.Description copied from class:DocIdSetIterator
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returnsDocIdSetIterator.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.- Specified by:
advance
in classDocIdSetIterator
- Throws:
IOException
-
cost
public long cost()Deprecated.Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.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.
- Specified by:
cost
in classDocIdSetIterator
-
reloadValues
Deprecated.- Throws:
IOException
-
loadValues
Deprecated.Load ordinals for the currently-positioned doc, assuming the default binary encoding.
-