core/org.gnit.lucenekmp.search/MultiPhraseQuery/PostingsAndPosition

PostingsAndPosition

class PostingsAndPosition(val pe: PostingsEnum) : PostingsEnum

Constructors

PostingsAndPosition

constructor(pe: PostingsEnum)

Properties

payload

open override val payload: BytesRef?

val pe: PostingsEnum

pos

var pos: Int

upto

var upto: Int

Functions

advance

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

cost

open override fun cost(): Long

Returns the estimated cost of this DocIdSetIterator.

docID

open override fun docID(): Int

Returns the following:

endOffset

open override fun endOffset(): Int

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

freq

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

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

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.

nextPosition

open override fun nextPosition(): Int

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

startOffset

open override fun startOffset(): Int

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