Package org.opensearch.index.fielddata

Class IndexHistogramFieldData

java.lang.Object

org.opensearch.index.fielddata.IndexHistogramFieldData

All Implemented Interfaces:

IndexFieldData<LeafHistogramFieldData>

public abstract class IndexHistogramFieldData
extends Object
implements IndexFieldData<LeafHistogramFieldData>

Specialization of IndexFieldData for histograms.

Opensearch.internal:

Nested Class Summary

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

IndexFieldData.Builder, 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
IndexHistogramFieldData(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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.index.fielddata.IndexFieldData

load, loadDirect, newBucketedSort, sortField

Field Details

fieldName

protected final String fieldName

valuesSourceType

protected final ValuesSourceType valuesSourceType

Constructor Details

IndexHistogramFieldData

public IndexHistogramFieldData(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<LeafHistogramFieldData>

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<LeafHistogramFieldData>