Package org.elasticsearch.index.fielddata

Interface IndexFieldData<FD extends AtomicFieldData>

All Superinterfaces:

IndexComponent

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractIndexFieldData, AbstractIndexOrdinalsFieldData, AbstractLatLonPointDVIndexFieldData, AbstractLatLonPointDVIndexFieldData.LatLonPointDVIndexFieldData, BinaryDVIndexFieldData, BytesBinaryDVIndexFieldData, ConstantIndexFieldData, GlobalOrdinalsIndexFieldData, GlobalOrdinalsIndexFieldData.Consumer, PagedBytesIndexFieldData, 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	Description
static interface	IndexFieldData.Builder
static interface	IndexFieldData.Global<FD extends AtomicFieldData>
static class	IndexFieldData.XFieldComparatorSource

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears any resources associated with this field data.
String	getFieldName()	The field name.
FD	load(LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
FD	loadDirect(LeafReaderContext context)	Loads directly the atomic field data for the reader, ignoring any caching involved.
SortField	sortField(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)	Returns the SortField to use for sorting.

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Method Detail

getFieldName

String getFieldName()

The field name.

load

FD load(LeafReaderContext context)

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

loadDirect

FD loadDirect(LeafReaderContext context)
       throws Exception

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

Throws:

Exception

sortField

SortField sortField(@Nullable
                    Object missingValue,
                    MultiValueMode sortMode,
                    IndexFieldData.XFieldComparatorSource.Nested nested,
                    boolean reverse)

Returns the SortField to use for sorting.

clear

void clear()

Clears any resources associated with this field data.