Package 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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	Description
protected IndexFieldDataCache	cache

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, indexSettings, logger

Constructor Summary

Constructors

Constructor	Description
AbstractIndexFieldData(IndexSettings indexSettings, java.lang.String fieldName, IndexFieldDataCache cache)

Method Summary

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

getIndexSettings, index

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

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

loadDirect, sortField

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected final IndexFieldDataCache cache

Constructor Detail

AbstractIndexFieldData

public AbstractIndexFieldData(IndexSettings indexSettings,
                              java.lang.String fieldName,
                              IndexFieldDataCache cache)

Method Detail

getFieldName

public java.lang.String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName 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)