Package org.opensearch.index.fielddata.plain

Class AbstractGeoShapeIndexFieldData

java.lang.Object

org.opensearch.index.fielddata.plain.AbstractGeoShapeIndexFieldData

All Implemented Interfaces:

IndexFieldData<LeafGeoShapeFieldData>

Direct Known Subclasses:

AbstractGeoShapeIndexFieldData.GeoShapeIndexFieldData

public abstract class AbstractGeoShapeIndexFieldData
extends Object
implements IndexFieldData<LeafGeoShapeFieldData>

Base class for retrieving Geometry docvalues

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractGeoShapeIndexFieldData.Builder	Builder class for creating the GeoShapeIndexFieldData.
static class	AbstractGeoShapeIndexFieldData.GeoShapeIndexFieldData	A concrete implementation of AbstractGeoShapeIndexFieldData which provides how to load the field data aka Doc Values from Lucene.

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

Method Summary

Modifier and Type	Method	Description
final String	getFieldName()	The field name.
ValuesSourceType	getValuesSourceType()	The ValuesSourceType of the underlying data.
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

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

load, loadDirect, wideSortField

Field Details

fieldName

protected final String fieldName

valuesSourceType

protected final ValuesSourceType valuesSourceType

Method Details

getFieldName

public final String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<LeafGeoShapeFieldData>

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

sortField

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

Returns the SortField to use for sorting.

Specified by:

sortField in interface IndexFieldData<LeafGeoShapeFieldData>

newBucketedSort

public 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.

Specified by:

newBucketedSort in interface IndexFieldData<LeafGeoShapeFieldData>