Package org.opensearch.index.fielddata.fieldcomparator

Class BytesRefFieldComparatorSource

java.lang.Object

org.apache.lucene.search.FieldComparatorSource

org.opensearch.index.fielddata.IndexFieldData.XFieldComparatorSource

org.opensearch.index.fielddata.fieldcomparator.BytesRefFieldComparatorSource

public class BytesRefFieldComparatorSource
extends IndexFieldData.XFieldComparatorSource

Comparator source for string/binary values.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.index.fielddata.IndexFieldData.XFieldComparatorSource

IndexFieldData.XFieldComparatorSource.Nested

Field Summary

Fields inherited from class org.opensearch.index.fielddata.IndexFieldData.XFieldComparatorSource

enableSkipping, missingValue, nested, sortMode

Constructor Summary

Constructors

Constructor	Description
BytesRefFieldComparatorSource(IndexFieldData<?> indexFieldData, Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested)

Method Summary

Modifier and Type	Method	Description
protected SortedBinaryDocValues	getValues(org.apache.lucene.index.LeafReaderContext context)
Object	missingValue(boolean reversed)	Return a missing value that is understandable by SortField.setMissingValue(Object).
BucketedSort	newBucketedSort(BigArrays bigArrays, SortOrder sortOrder, DocValueFormat format, int bucketSize, BucketedSort.ExtraData extra)	Create a BucketedSort which is useful for sorting inside of aggregations.
org.apache.lucene.search.FieldComparator<?>	newComparator(String fieldname, int numHits, org.apache.lucene.search.Pruning pruning, boolean reversed)
org.apache.lucene.search.SortField.Type	reducedType()
protected void	setScorer(org.apache.lucene.search.Scorable scorer, org.apache.lucene.index.LeafReaderContext context)

Methods inherited from class org.opensearch.index.fielddata.IndexFieldData.XFieldComparatorSource

disableSkipping, filterPruning, missingObject, nested, sortMissingFirst, sortMissingLast, sortMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BytesRefFieldComparatorSource

public BytesRefFieldComparatorSource(IndexFieldData<?> indexFieldData,
 Object missingValue,
 MultiValueMode sortMode,
 IndexFieldData.XFieldComparatorSource.Nested nested)

Method Details

reducedType

public org.apache.lucene.search.SortField.Type reducedType()

Specified by:

reducedType in class IndexFieldData.XFieldComparatorSource

missingValue

public Object missingValue(boolean reversed)

Description copied from class: IndexFieldData.XFieldComparatorSource

Return a missing value that is understandable by SortField.setMissingValue(Object). Most implementations return null because they already replace the value at the fielddata level. However this can't work in case of strings since there is no such thing as a string which compares greater than any other string, so in that case we need to return SortField.STRING_FIRST or SortField.STRING_LAST so that the coordinating node knows how to deal with null values.

Overrides:

missingValue in class IndexFieldData.XFieldComparatorSource

getValues

protected SortedBinaryDocValues getValues(org.apache.lucene.index.LeafReaderContext context)
                                   throws IOException

Throws:

IOException

setScorer

protected void setScorer(org.apache.lucene.search.Scorable scorer,
 org.apache.lucene.index.LeafReaderContext context)

newComparator

public org.apache.lucene.search.FieldComparator<?> newComparator(String fieldname,
 int numHits,
 org.apache.lucene.search.Pruning pruning,
 boolean reversed)

Specified by:

newComparator in class org.apache.lucene.search.FieldComparatorSource

newBucketedSort

public BucketedSort newBucketedSort(BigArrays bigArrays,
 SortOrder sortOrder,
 DocValueFormat format,
 int bucketSize,
 BucketedSort.ExtraData extra)

Description copied from class: IndexFieldData.XFieldComparatorSource

Create a BucketedSort which is useful for sorting inside of aggregations.

Specified by:

newBucketedSort in class IndexFieldData.XFieldComparatorSource