Package org.elasticsearch.index.fielddata.plain

Class AbstractIndexOrdinalsFieldData

java.lang.Object

org.elasticsearch.index.fielddata.plain.AbstractIndexOrdinalsFieldData

All Implemented Interfaces:

IndexFieldData<LeafOrdinalsFieldData>, IndexFieldData.Global<LeafOrdinalsFieldData>, IndexOrdinalsFieldData

Direct Known Subclasses:

ConstantIndexFieldData, PagedBytesIndexFieldData, SortedSetOrdinalsIndexFieldData

public abstract class AbstractIndexOrdinalsFieldData
extends Object
implements IndexOrdinalsFieldData

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractIndexOrdinalsFieldData.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.Global<FD extends LeafFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields

Modifier and Type	Field	Description
protected CircuitBreakerService	breakerService
protected Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>>	scriptFunction

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIndexOrdinalsFieldData(String fieldName, ValuesSourceType valuesSourceType, IndexFieldDataCache cache, CircuitBreakerService breakerService, Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Summary

Modifier and Type	Method	Description
String	getFieldName()	The field name.
org.apache.lucene.index.OrdinalMap	getOrdinalMap()	Returns the underlying OrdinalMap for this fielddata or null if global ordinals are not needed (constant value or single segment).
ValuesSourceType	getValuesSourceType()	The ValuesSourceType of the underlying data.
LeafOrdinalsFieldData	load(org.apache.lucene.index.LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
IndexOrdinalsFieldData	loadGlobal(org.apache.lucene.index.DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader, potentially from a cache.
IndexOrdinalsFieldData	loadGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader.
boolean	supportsGlobalOrdinalsMapping()	Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlying OrdinalMap.

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

loadDirect, newBucketedSort, sortField

Field Details

breakerService

protected final CircuitBreakerService breakerService

scriptFunction

protected final Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction

Constructor Details

AbstractIndexOrdinalsFieldData

protected AbstractIndexOrdinalsFieldData(String fieldName,
 ValuesSourceType valuesSourceType,
 IndexFieldDataCache cache,
 CircuitBreakerService breakerService,
 Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Details

getFieldName

public String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<LeafOrdinalsFieldData>

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

getOrdinalMap

public org.apache.lucene.index.OrdinalMap getOrdinalMap()

Description copied from interface: IndexOrdinalsFieldData

Returns the underlying OrdinalMap for this fielddata or null if global ordinals are not needed (constant value or single segment).

Specified by:

getOrdinalMap in interface IndexOrdinalsFieldData

load

public LeafOrdinalsFieldData 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<LeafOrdinalsFieldData>

loadGlobal

public IndexOrdinalsFieldData loadGlobal(org.apache.lucene.index.DirectoryReader indexReader)

Description copied from interface: IndexOrdinalsFieldData

Load a global view of the ordinals for the given IndexReader, potentially from a cache.

Specified by:

loadGlobal in interface IndexFieldData.Global<LeafOrdinalsFieldData>

Specified by:

loadGlobal in interface IndexOrdinalsFieldData

loadGlobalDirect

public IndexOrdinalsFieldData loadGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)
                                        throws Exception

Description copied from interface: IndexOrdinalsFieldData

Load a global view of the ordinals for the given IndexReader.

Specified by:

loadGlobalDirect in interface IndexFieldData.Global<LeafOrdinalsFieldData>

Specified by:

loadGlobalDirect in interface IndexOrdinalsFieldData

Throws:

Exception

supportsGlobalOrdinalsMapping

public boolean supportsGlobalOrdinalsMapping()

Description copied from interface: IndexOrdinalsFieldData

Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlying OrdinalMap. If this method returns false, then calling IndexOrdinalsFieldData.getOrdinalMap() will result in an UnsupportedOperationException.

Specified by:

supportsGlobalOrdinalsMapping in interface IndexOrdinalsFieldData