org.elasticsearch.index.fielddata

Interface IndexFieldData<FD extends AtomicFieldData>

All Superinterfaces:

IndexComponent

All Known Subinterfaces:

IndexFieldData.Global<FD>, IndexGeoPointFieldData, IndexNumericFieldData, IndexOrdinalsFieldData, IndexParentChildFieldData

All Known Implementing Classes:

AbstractGeoPointDVIndexFieldData, AbstractGeoPointDVIndexFieldData.GeoPointDVIndexFieldData, AbstractIndexFieldData, AbstractIndexOrdinalsFieldData, BinaryDVIndexFieldData, BinaryDVNumericIndexFieldData, BytesBinaryDVIndexFieldData, DoubleArrayIndexFieldData, FloatArrayIndexFieldData, GeoPointArrayIndexFieldData, GlobalOrdinalsIndexFieldData, IndexIndexFieldData, PackedArrayIndexFieldData, PagedBytesIndexFieldData, ParentChildIndexFieldData, ParentChildIndexFieldData.GlobalFieldData, SortedNumericDVIndexFieldData, SortedSetDVOrdinalsIndexFieldData

public interface IndexFieldData<FD extends AtomicFieldData>
extends IndexComponent

Thread-safe utility class that allows to get per-segment values via the load(LeafReaderContext) method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IndexFieldData.Builder
static class	IndexFieldData.CommonSettings
static interface	IndexFieldData.Global<FD extends AtomicFieldData>
static class	IndexFieldData.XFieldComparatorSource

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears any resources associated with this field data.
IndexFieldData.XFieldComparatorSource	comparatorSource(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested) Comparator used for sorting.
FieldDataType	getFieldDataType() The field data type.
MappedFieldType.Names	getFieldNames() The field name.
FD	load(org.apache.lucene.index.LeafReaderContext context) Loads the atomic field data for the reader, possibly cached.
FD	loadDirect(org.apache.lucene.index.LeafReaderContext context) Loads directly the atomic field data for the reader, ignoring any caching involved.

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Method Detail

getFieldNames

MappedFieldType.Names getFieldNames()

The field name.

getFieldDataType

FieldDataType getFieldDataType()

The field data type.

load

FD load(org.apache.lucene.index.LeafReaderContext context)

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

loadDirect

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

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

Throws:

Exception

comparatorSource

IndexFieldData.XFieldComparatorSource comparatorSource(@Nullable
                                                     Object missingValue,
                                                     MultiValueMode sortMode,
                                                     IndexFieldData.XFieldComparatorSource.Nested nested)

Comparator used for sorting.

clear

void clear()

Clears any resources associated with this field data.