core/org.gnit.lucenekmp.search/FieldValueHitQueue

FieldValueHitQueue

abstract class FieldValueHitQueue<T : FieldValueHitQueue.Entry> : PriorityQueue<T>

Expert: A hit queue for sorting by hits by terms in more than one field.

Since

2.9

See also

IndexSearcher.search

Types

object Companion

Returns the SortFields being used by this hit queue.

open class Entry(var slot: Int, doc: Int) : ScoreDoc

Extension of ScoreDoc to also store the FieldComparator slot.

Properties

val comparators: Array<FieldComparator<*>>

val fields: Array<SortField>

Stores the sort criteria being used.

val reverseMul: IntArray

Functions

fun add(element: T): T?

fun addAll(elements: MutableCollection<T>)

expect fun clear()

fun fillFields(entry: FieldValueHitQueue.Entry): FieldDoc

Given a queue Entry, creates a corresponding FieldDoc that contains the values used to sort the given document. These values are not the raw values out of the index, but the internal representation of them. This is so the given search hit can be collated by a MultiSearcher with other search hits.

fun getComparators(context: LeafReaderContext): Array<LeafFieldComparator>

insertWithOverflow

fun insertWithOverflow(element: T): T?

open operator override fun iterator(): Iterator<T>

abstract override fun lessThan(a: T, b: T): Boolean

fun pop(): T?

fun remove(element: T): Boolean

expect fun size(): Int

fun top(): T

fun topOrNull(): T?

fun updateTop(): T

fun updateTop(newTop: T): T