Package org.elasticsearch.index.fielddata

Interface IndexFieldData<FD extends LeafFieldData>

All Superinterfaces:

IndexComponent

All Known Subinterfaces:

IndexFieldData.Global<FD>, IndexGeoPointFieldData, IndexOrdinalsFieldData

All Known Implementing Classes:

AbstractIndexFieldData, AbstractIndexOrdinalsFieldData, AbstractLatLonPointIndexFieldData, AbstractLatLonPointIndexFieldData.LatLonPointIndexFieldData, BinaryIndexFieldData, BytesBinaryIndexFieldData, ConstantIndexFieldData, GlobalOrdinalsIndexFieldData, GlobalOrdinalsIndexFieldData.Consumer, IndexHistogramFieldData, IndexNumericFieldData, PagedBytesIndexFieldData, SortedNumericIndexFieldData, SortedSetOrdinalsIndexFieldData, StringBinaryIndexFieldData

public interface IndexFieldData<FD extends LeafFieldData>
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 LeafFieldData>
static class	IndexFieldData.XFieldComparatorSource

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears any resources associated with this field data.
java.lang.String	getFieldName()	The field name.
ValuesSourceType	getValuesSourceType()	The ValuesSourceType of the underlying data.
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.
BucketedSort	newBucketedSort(BigArrays bigArrays, java.lang.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(java.lang.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 Details

getFieldName

java.lang.String getFieldName()

The field name.

getValuesSourceType

ValuesSourceType getValuesSourceType()

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.

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 java.lang.Exception

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

Throws:

java.lang.Exception

sortField

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

Returns the SortField to use for sorting.

newBucketedSort

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

Build a sort implementation specialized for aggregations.

clear

void clear()

Clears any resources associated with this field data.