Package org.opensearch.index.fielddata.plain

Class BinaryIndexFieldData

java.lang.Object

org.opensearch.index.fielddata.plain.BinaryIndexFieldData

All Implemented Interfaces:

IndexFieldData<BinaryDVLeafFieldData>

public class BinaryIndexFieldData
extends Object
implements IndexFieldData<BinaryDVLeafFieldData>

Binary doc values ValuesSource

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BinaryIndexFieldData.Builder	Builder for binary index field data

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

IndexFieldData.Global<FD extends LeafFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fieldName
protected final ValuesSourceType	valuesSourceType

Constructor Summary

Constructors

Constructor	Description
BinaryIndexFieldData(String fieldName, ValuesSourceType valuesSourceType)

Method Summary

Modifier and Type	Method	Description
final String	getFieldName()	The field name.
ValuesSourceType	getValuesSourceType()	The ValuesSourceType of the underlying data.
BinaryDVLeafFieldData	load(org.apache.lucene.index.LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
BinaryDVLeafFieldData	loadDirect(org.apache.lucene.index.LeafReaderContext context)	Loads directly the atomic field data for the reader, ignoring any caching involved.
BucketedSort	newBucketedSort(BigArrays bigArrays, Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, SortOrder sortOrder, DocValueFormat format, int bucketSize, BucketedSort.ExtraData extra)	Build a sort implementation specialized for aggregations.
org.apache.lucene.search.SortField	sortField(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)	Returns the SortField to use for sorting.

Methods inherited from class java.lang.Object

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

Field Details

fieldName

protected final String fieldName

valuesSourceType

protected final ValuesSourceType valuesSourceType

Constructor Details

BinaryIndexFieldData

public BinaryIndexFieldData(String fieldName,
 ValuesSourceType valuesSourceType)

Method Details

getFieldName

public final String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<BinaryDVLeafFieldData>

getValuesSourceType

public ValuesSourceType getValuesSourceType()

Description copied from interface: IndexFieldData

The ValuesSourceType of the underlying data. It's possible for fields that use the same IndexFieldData implementation to have different ValuesSourceTypes, such as in the case of Longs and Dates.

Specified by:

getValuesSourceType in interface IndexFieldData<BinaryDVLeafFieldData>

load

public BinaryDVLeafFieldData load(org.apache.lucene.index.LeafReaderContext context)

Description copied from interface: IndexFieldData

Loads the atomic field data for the reader, possibly cached.

Specified by:

load in interface IndexFieldData<BinaryDVLeafFieldData>

loadDirect

public BinaryDVLeafFieldData loadDirect(org.apache.lucene.index.LeafReaderContext context)
                                 throws Exception

Description copied from interface: IndexFieldData

Loads directly the atomic field data for the reader, ignoring any caching involved.

Specified by:

loadDirect in interface IndexFieldData<BinaryDVLeafFieldData>

Throws:

Exception

sortField

public org.apache.lucene.search.SortField sortField(@Nullable
 Object missingValue,
 MultiValueMode sortMode,
 IndexFieldData.XFieldComparatorSource.Nested nested,
 boolean reverse)

Description copied from interface: IndexFieldData

Returns the SortField to use for sorting.

Specified by:

sortField in interface IndexFieldData<BinaryDVLeafFieldData>

newBucketedSort

public BucketedSort newBucketedSort(BigArrays bigArrays,
 Object missingValue,
 MultiValueMode sortMode,
 IndexFieldData.XFieldComparatorSource.Nested nested,
 SortOrder sortOrder,
 DocValueFormat format,
 int bucketSize,
 BucketedSort.ExtraData extra)

Description copied from interface: IndexFieldData

Build a sort implementation specialized for aggregations.

Specified by:

newBucketedSort in interface IndexFieldData<BinaryDVLeafFieldData>