ImpactsEnum

Extension of PostingsEnum which also provides information about upcoming impacts.

Inheritors

Properties

Link copied to clipboard
abstract val impacts: Impacts
Link copied to clipboard
abstract val payload: BytesRef?

Functions

Link copied to clipboard
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.

Link copied to clipboard
abstract fun advanceShallow(target: Int)

Shallow-advance to target. This is cheaper than calling DocIdSetIterator.advance and allows further calls to .getImpacts to ignore doc IDs that are less than target in order to get more precise information about impacts. This method may not be called on targets that are less than the current DocIdSetIterator.docID. After this method has been called, DocIdSetIterator.nextDoc may not be called if the current doc ID is less than `target

Link copied to clipboard
abstract fun cost(): Long

Returns the estimated cost of this DocIdSetIterator.

Link copied to clipboard
abstract fun docID(): Int

Returns the following:

Link copied to clipboard
abstract fun endOffset(): Int

Returns end offset for the current position, or -1 if offsets were not indexed.

Link copied to clipboard
abstract fun freq(): Int

Returns term frequency in the current document, or 1 if the field was indexed with . Do not call this before .nextDoc is first called, nor after .nextDoc returns DocIdSetIterator.NO_MORE_DOCS.

Link copied to clipboard
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:

Link copied to clipboard
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.

Link copied to clipboard
abstract fun nextPosition(): Int

Returns the next position, or -1 if positions were not indexed. Calling this more than .freq times is undefined.

Link copied to clipboard
abstract fun startOffset(): Int

Returns start offset for the current position, or -1 if offsets were not indexed.