Spans

abstract class Spans : DocIdSetIterator

Iterates through combinations of start/end positions per-doc. Each start/end position represents a range of term positions within the current document. These are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position.

Inheritors

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Functions

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

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

Link copied to clipboard
abstract fun collect(collector: SpanCollector)

Collect postings data from the leaves of the current Spans.

Link copied to clipboard
abstract fun cost(): Long
Link copied to clipboard
abstract fun docID(): Int
Link copied to clipboard
abstract 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.

Link copied to clipboard
open fun intoBitSet(upTo: Int, bitSet: FixedBitSet, offset: Int)
Link copied to clipboard
abstract fun nextDoc(): Int
Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract fun positionsCost(): Float

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

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

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
abstract fun width(): Int

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