org.elasticsearch.index.fielddata.plain

Class AbstractIndexFieldData<FD extends AtomicFieldData>

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData<FD>

All Implemented Interfaces:

IndexFieldData<FD>, IndexComponent

Direct Known Subclasses:

AbstractIndexOrdinalsFieldData, DoubleArrayIndexFieldData, FloatArrayIndexFieldData, GeoPointArrayIndexFieldData, PackedArrayIndexFieldData, ParentChildIndexFieldData

public abstract class AbstractIndexFieldData<FD extends AtomicFieldData>
extends AbstractIndexComponent
implements IndexFieldData<FD>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractIndexFieldData.PerValueEstimator A PerValueEstimator is a sub-class that can be used to estimate the memory overhead for loading the data.

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

IndexFieldData.Builder, IndexFieldData.CommonSettings, IndexFieldData.Global<FD extends AtomicFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexFieldDataCache	cache
protected FieldDataType	fieldDataType

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, index, indexSettings, logger

Constructor Summary

Constructors

Constructor and Description
AbstractIndexFieldData(Index index, Settings indexSettings, MappedFieldType.Names fieldNames, FieldDataType fieldDataType, IndexFieldDataCache cache)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears any resources associated with this field data.
protected abstract FD	empty(int maxDoc)
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.

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, indexSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

comparatorSource, loadDirect

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Field Detail

fieldDataType

protected final FieldDataType fieldDataType

cache

protected final IndexFieldDataCache cache

Constructor Detail

AbstractIndexFieldData

public AbstractIndexFieldData(Index index,
                      Settings indexSettings,
                      MappedFieldType.Names fieldNames,
                      FieldDataType fieldDataType,
                      IndexFieldDataCache cache)

Method Detail

getFieldNames

public MappedFieldType.Names getFieldNames()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldNames in interface IndexFieldData<FD extends AtomicFieldData>

getFieldDataType

public FieldDataType getFieldDataType()

Description copied from interface: IndexFieldData

The field data type.

Specified by:

getFieldDataType in interface IndexFieldData<FD extends AtomicFieldData>

clear

public void clear()

Description copied from interface: IndexFieldData

Clears any resources associated with this field data.

Specified by:

clear in interface IndexFieldData<FD extends AtomicFieldData>

load

public FD 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<FD extends AtomicFieldData>

empty

protected abstract FD empty(int maxDoc)

Parameters:

maxDoc - of the current reader

Returns:

an empty field data instances for field data lookups of empty segments (returning no values)