core/org.gnit.lucenekmp.index/BinaryDocValues

BinaryDocValues

abstract class BinaryDocValues : DocValuesIterator

A per-document numeric value.

Inheritors

BinaryRangeDocValues

FilterBinaryDocValues

Functions

advance

abstract fun advance(target: Int): Int

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 returns .NO_MORE_DOCS if target is greater than the highest document number in the set.

advanceExact

abstract fun advanceExact(target: Int): Boolean

Advance the iterator to exactly target and return whether target has a value. target must be greater than or equal to the current .docID and must be a valid doc ID, ie. 0 and <maxDoc. After this method returns, .docID returns target.

binaryValue

abstract fun binaryValue(): BytesRef?

Returns the binary value for the current document ID. It is illegal to call this method after .advanceExact returned false.

cost

abstract fun cost(): Long

Returns the estimated cost of this DocIdSetIterator.

docID

abstract fun docID(): Int

Returns the following:

intoBitSet

open fun intoBitSet(upTo: Int, bitSet: FixedBitSet, offset: Int)

Load doc IDs into a FixedBitSet. This should behave exactly as if implemented as below, which is the default implementation:

nextDoc

abstract fun nextDoc(): Int

Advances to the next document in the set and returns the doc it is currently on, or .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.