queries/org.gnit.lucenekmp.queries.spans/TermSpans

TermSpans

open class TermSpans(postingsInternal: PostingsEnum, term: Term, positionsCostInternal: Float) : Spans

Expert: Public for extension only. This does not work correctly for terms that indexed at position Integer.MAX_VALUE.

Constructors

TermSpans

constructor(postingsInternal: PostingsEnum, term: Term, positionsCostInternal: Float)

Functions

advance

open override fun advance(target: Int): Int

asTwoPhaseIterator

open fun asTwoPhaseIterator(): TwoPhaseIterator?

Optional method: Return a TwoPhaseIterator view of this Spans. A return value of null indicates that two-phase iteration is not supported.

collect

open override fun collect(collector: SpanCollector)

Collect postings data from the leaves of the current Spans.

cost

open override fun cost(): Long

docID

open override fun docID(): Int

endPosition

open override fun endPosition(): Int

Returns the end position for the current start position, or -1 when nextStartPosition was not yet called on the current doc. After the last start/end position at the current doc this returns NO_MORE_POSITIONS.

getPostings

fun getPostings(): PostingsEnum

intoBitSet

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

nextDoc

open override fun nextDoc(): Int

nextStartPosition

open override fun nextStartPosition(): Int

Returns the next start position for the current doc. There is always at least one start/end position per doc. After the last start/end position at the current doc this returns NO_MORE_POSITIONS.

positionsCost

open override fun positionsCost(): Float

Return an estimation of the cost of using the positions of this Spans for any single document.

startPosition

open override fun startPosition(): Int

Returns the start position in the current doc, or -1 when nextStartPosition was not yet called on the current doc. After the last start/end position at the current doc this returns NO_MORE_POSITIONS.

toString

open override fun toString(): String

width

open override fun width(): Int

Return the width of the match, which is typically used to sloppy freq.