core/org.gnit.lucenekmp.search/SortedSetSortField

SortedSetSortField

class SortedSetSortField(field: String, reverse: Boolean, val selector: SortedSetSelector.Type = SortedSetSelector.Type.MIN) : SortField

SortField for SortedSetDocValues.

A SortedSetDocValues contains multiple values for a field, so sorting with this technique "selects" a value as the representative sort value for the document.

By default, the minimum value in the set is selected as the sort value, but this can be customized. Selectors other than the default do have some limitations to ensure that all selections happen in constant-time for performance.

Like sorting by string, this also supports sorting missing values as first or last, via .setMissingValue.

Constructors

SortedSetSortField

constructor(field: String, reverse: Boolean, selector: SortedSetSelector.Type = SortedSetSelector.Type.MIN)

Types

Companion

object Companion

Provider

class Provider : SortFieldProvider

A SortFieldProvider for this sort

Properties

field

var field: String?

Returns the name of the field. Could return null if the sort is by SCORE or DOC.

indexSorter

open override val indexSorter: IndexSorter

Returns an IndexSorter used for sorting index segments by this SortField.

missingValue

open override var missingValue: Any?

Set how missing values (the empty set) are sorted.

optimizeSortWithIndexedData

var ~~optimizeSortWithIndexedData~~: Boolean

Returns whether sort optimization should be optimized with indexed data

optimizeSortWithPoints

var optimizeSortWithPoints: Boolean

reverse

var reverse: Boolean

Returns whether the sort should be reversed.

selector

val selector: SortedSetSelector.Type

type

open lateinit var type: SortField.Type

Functions

equals

open operator override fun equals(obj: Any?): Boolean

Returns true if o is equal to this. If a FieldComparatorSource was provided, it must properly implement equals (unless a singleton is always used).

getBytesComparator

fun getBytesComparator(): Comparator<BytesRef>

getComparator

open override fun getComparator(numHits: Int, pruning: Pruning): FieldComparator<*>

Returns the FieldComparator to use for sorting.

getComparatorSource

fun getComparatorSource(): FieldComparatorSource?

Returns the FieldComparatorSource used for custom sorting

hashCode

open override fun hashCode(): Int

Returns the selector in use for this sort

needsScores

open fun needsScores(): Boolean

Whether the relevance score is needed to sort documents.

rewrite

open fun rewrite(searcher: IndexSearcher): SortField

Rewrites this SortField, returning a new SortField if a change is made. Subclasses should override this define their rewriting behavior when this SortField is of type

setBytesComparator

fun setBytesComparator(b: Comparator<BytesRef>)

toString

open override fun toString(): String

SortedSetSortField

See also

Constructors

Types

Properties

Functions