Module org.elasticsearch.server

Package org.elasticsearch.index.fielddata

Class IndexFieldDataService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.fielddata.IndexFieldDataService

All Implemented Interfaces:

Closeable, AutoCloseable

public class IndexFieldDataService
extends AbstractIndexComponent
implements Closeable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELDDATA_CACHE_KEY
static final String	FIELDDATA_CACHE_VALUE_NODE
static final Setting<String>	INDEX_FIELDDATA_CACHE_KEY

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

indexSettings, logger

Constructor Summary

Constructors

Constructor	Description
IndexFieldDataService(IndexSettings indexSettings, IndicesFieldDataCache indicesFieldDataCache, CircuitBreakerService circuitBreakerService)

Method Summary

Modifier and Type	Method	Description
void	clear()
void	clearField(String fieldName)
void	close()
<IFD extends IndexFieldData<?>> IFD	getForField(MappedFieldType fieldType, FieldDataContext fieldDataContext)	Returns fielddata for the provided field type, given the provided fully qualified index name, while also making a SearchLookup supplier available that is required for runtime fields.
<IFD extends IndexFieldData<?>> IFD	getFromBuilder(MappedFieldType fieldType, IndexFieldData.Builder builder)
void	setListener(IndexFieldDataCache.Listener listener)	Sets a IndexFieldDataCache.Listener passed to each IndexFieldData creation to capture onCache and onRemoval events.

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

getIndexSettings, index

Methods inherited from class java.lang.Object

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

Field Details

FIELDDATA_CACHE_VALUE_NODE

public static final String FIELDDATA_CACHE_VALUE_NODE

See Also:

• Constant Field Values

FIELDDATA_CACHE_KEY

public static final String FIELDDATA_CACHE_KEY

See Also:

• Constant Field Values

INDEX_FIELDDATA_CACHE_KEY

public static final Setting<String> INDEX_FIELDDATA_CACHE_KEY

Constructor Details

IndexFieldDataService

public IndexFieldDataService(IndexSettings indexSettings,
 IndicesFieldDataCache indicesFieldDataCache,
 CircuitBreakerService circuitBreakerService)

Method Details

clear

public void clear()

clearField

public void clearField(String fieldName)

getForField

public <IFD extends IndexFieldData<?>> IFD getForField(MappedFieldType fieldType,
 FieldDataContext fieldDataContext)

Returns fielddata for the provided field type, given the provided fully qualified index name, while also making a SearchLookup supplier available that is required for runtime fields.

getFromBuilder

public <IFD extends IndexFieldData<?>> IFD getFromBuilder(MappedFieldType fieldType,
 IndexFieldData.Builder builder)

setListener

public void setListener(IndexFieldDataCache.Listener listener)

Sets a IndexFieldDataCache.Listener passed to each IndexFieldData creation to capture onCache and onRemoval events. Setting a listener on this method will override any previously set listeners.

Throws:

IllegalStateException - if the listener is set more than once

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable