Module org.elasticsearch.server

Package org.elasticsearch.index.fielddata

Class StoredFieldIndexFieldData<T>

java.lang.Object

org.elasticsearch.index.fielddata.StoredFieldIndexFieldData<T>

All Implemented Interfaces:

IndexFieldData<StoredFieldIndexFieldData<T>.StoredFieldLeafFieldData>

Direct Known Subclasses:

StoredFieldSortedBinaryIndexFieldData

public abstract class StoredFieldIndexFieldData<T>
extends Object
implements IndexFieldData<StoredFieldIndexFieldData<T>.StoredFieldLeafFieldData>

Per segment values for a field loaded from stored fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StoredFieldIndexFieldData.StoredFieldLeafFieldData

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

IndexFieldData.Builder, IndexFieldData.Global<FD extends LeafFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields

Modifier and Type	Field	Description
protected final StoredFieldLoader	loader
protected final ToScriptFieldFactory<T>	toScriptFieldFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StoredFieldIndexFieldData(String fieldName, ValuesSourceType valuesSourceType, ToScriptFieldFactory<T> toScriptFieldFactory)

Method Summary

Modifier and Type	Method	Description
String	getFieldName()	The field name.
ValuesSourceType	getValuesSourceType()	The ValuesSourceType of the underlying data.
final StoredFieldIndexFieldData<T>.StoredFieldLeafFieldData	load(org.apache.lucene.index.LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
final StoredFieldIndexFieldData<T>.StoredFieldLeafFieldData	loadDirect(org.apache.lucene.index.LeafReaderContext context)	Loads directly the atomic field data for the reader, ignoring any caching involved.
protected abstract T	loadLeaf(LeafStoredFieldLoader leafStoredFieldLoader)
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

Field Details

toScriptFieldFactory

protected final ToScriptFieldFactory<T> toScriptFieldFactory

loader

protected final StoredFieldLoader loader

Constructor Details

StoredFieldIndexFieldData

protected StoredFieldIndexFieldData(String fieldName,
 ValuesSourceType valuesSourceType,
 ToScriptFieldFactory<T> toScriptFieldFactory)

Method Details

getFieldName

public String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<T>

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

load

public final StoredFieldIndexFieldData<T>.StoredFieldLeafFieldData load(org.apache.lucene.index.LeafReaderContext context)

Description copied from interface: IndexFieldData

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

Specified by:

load in interface IndexFieldData<T>

loadDirect

public final StoredFieldIndexFieldData<T>.StoredFieldLeafFieldData loadDirect(org.apache.lucene.index.LeafReaderContext context)
                                                                       throws IOException

Description copied from interface: IndexFieldData

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

Specified by:

loadDirect in interface IndexFieldData<T>

Throws:

IOException

loadLeaf

protected abstract T loadLeaf(LeafStoredFieldLoader leafStoredFieldLoader)

sortField

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

Description copied from interface: IndexFieldData

Returns the SortField to use for sorting.

Specified by:

sortField in interface IndexFieldData<T>

newBucketedSort

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

Description copied from interface: IndexFieldData

Build a sort implementation specialized for aggregations.

Specified by:

newBucketedSort in interface IndexFieldData<T>