core/org.gnit.lucenekmp.index/IndexSorter

IndexSorter

interface IndexSorter

Handles how documents should be sorted in an index, both within a segment and between segments.

Implementers must provide the following methods:

.getDocComparator - an object that determines how documents within a segment are to be sorted
.getComparableProviders - an array of objects that return a sortable long value per document and segment
.getProviderName - the SPI-registered name of a SortFieldProvider to serialize the sort

The companion SortFieldProvider should be registered with SPI via META-INF/services

Inheritors

Types

ComparableProvider

interface ComparableProvider

Used for sorting documents across segments

DocComparator

fun interface DocComparator

A comparator of doc IDs, used for sorting documents within a segment

DoubleSorter

class DoubleSorter(val providerName: String, missingValue: Double?, reverse: Boolean, valuesProvider: IndexSorter.NumericDocValuesProvider) : IndexSorter

Sorts documents based on double values from a NumericDocValues instance

FloatSorter

class FloatSorter(val providerName: String, missingValue: Float?, reverse: Boolean, valuesProvider: IndexSorter.NumericDocValuesProvider) : IndexSorter

Sorts documents based on float values from a NumericDocValues instance

IntSorter

class IntSorter(val providerName: String, missingValue: Int?, reverse: Boolean, valuesProvider: IndexSorter.NumericDocValuesProvider) : IndexSorter

Sorts documents based on integer values from a NumericDocValues instance

LongSorter

class LongSorter(val providerName: String, missingValue: Long?, reverse: Boolean, valuesProvider: IndexSorter.NumericDocValuesProvider) : IndexSorter

Sorts documents based on long values from a NumericDocValues instance

NumericDocValuesProvider

fun interface NumericDocValuesProvider

Provide a NumericDocValues instance for a LeafReader

SortedDocValuesProvider

fun interface SortedDocValuesProvider

Provide a SortedDocValues instance for a LeafReader

StringSorter

open class StringSorter(val providerName: String, missingValue: Any?, reverse: Boolean, valuesProvider: IndexSorter.SortedDocValuesProvider) : IndexSorter

Sorts documents based on terms from a SortedDocValues instance

Properties

providerName

abstract val providerName: String

The SPI-registered name of a SortFieldProvider that will deserialize the parent SortField

Functions

getComparableProviders

abstract fun getComparableProviders(readers: MutableList<out LeafReader>): Array<IndexSorter.ComparableProvider>

Get an array of ComparableProvider, one per segment, for merge sorting documents in different segments

getDocComparator

abstract fun getDocComparator(reader: LeafReader, maxDoc: Int): IndexSorter.DocComparator

Get a comparator that determines the sort order of docs within a single Reader.