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

open override fun advanceExact(targetDocID: 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.

cost

open override fun cost(): Long

Returns the estimated cost of this DocIdSetIterator.

docID

open override fun docID(): Int

Returns the following:

docValueCount

open override fun docValueCount(): Int

Retrieves the number of unique ords for the current document. This must always be greater than zero. It is illegal to call this method after .advanceExact returned false.

intersect

open fun intersect(automaton: CompiledAutomaton): TermsEnum

Returns a TermsEnum over the values, filtered by a CompiledAutomaton The enum supports TermsEnum.ord.

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:

lookupOrd

open override fun lookupOrd(ord: Long): BytesRef?

Retrieves the value for the specified ordinal. The returned BytesRef may be re-used across calls to lookupOrd so make sure to copy it if you want to keep it around.

lookupTerm

open fun lookupTerm(key: BytesRef): Long

If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.

nextDoc

open override 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.

nextOrd

open override fun nextOrd(): Long

Returns the next ordinal for the current document. It is illegal to call this method after .advanceExact returned false. It is illegal to call this more than .docValueCount times for the currently-positioned doc.

termsEnum

open fun termsEnum(): TermsEnum

Returns a TermsEnum over the values. The enum supports TermsEnum.ord and TermsEnum.seekExact.