Package org.elasticsearch.index.fielddata.ordinals

Class GlobalOrdinalsIndexFieldData

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.fielddata.ordinals.GlobalOrdinalsIndexFieldData

All Implemented Interfaces:

Accountable, IndexFieldData<AtomicOrdinalsFieldData>, IndexFieldData.Global<AtomicOrdinalsFieldData>, IndexOrdinalsFieldData, IndexComponent

public final class GlobalOrdinalsIndexFieldData
extends AbstractIndexComponent
implements IndexOrdinalsFieldData, Accountable

Concrete implementation of IndexOrdinalsFieldData for global ordinals. A single instance of this class should be used to cache global ordinals per DirectoryReader. However loadGlobal(DirectoryReader) always creates a new instance of GlobalOrdinalsIndexFieldData.Consumer from the cached value in order to reuse the segment's TermsEnum that are needed to retrieve terms from global ordinals. Each instance of GlobalOrdinalsIndexFieldData.Consumer uses a new set of TermsEnum that can be reused during the collection, this is done to avoid creating all segment's TermsEnum each time we want to access the values of a single segment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GlobalOrdinalsIndexFieldData.Consumer	A non-thread safe IndexOrdinalsFieldData for global ordinals that creates the TermsEnum of each segment once and use them to provide a single lookup per segment.

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

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

Field Summary

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, indexSettings, logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GlobalOrdinalsIndexFieldData(IndexSettings indexSettings, String fieldName, AtomicOrdinalsFieldData[] segmentAfd, OrdinalMap ordinalMap, long memorySizeInBytes, Function<SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears any resources associated with this field data.
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
String	getFieldName()	The field name.
OrdinalMap	getOrdinalMap()	Returns the underlying OrdinalMap for this fielddata or null if global ordinals are not needed (constant value or single segment).
AtomicOrdinalsFieldData	load(LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
AtomicOrdinalsFieldData	loadDirect(LeafReaderContext context)	Loads directly the atomic field data for the reader, ignoring any caching involved.
IndexOrdinalsFieldData	loadGlobal(DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader, potentially from a cache.
IndexOrdinalsFieldData	localGlobalDirect(DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader.
IndexOrdinalsFieldData	newConsumer(DirectoryReader source)
long	ramBytesUsed()	Return the memory usage of this object in bytes.
SortField	sortField(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)	Returns the SortField to use for sorting.
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 org.elasticsearch.index.AbstractIndexComponent

getIndexSettings, index

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.IndexComponent

index

Constructor Detail

GlobalOrdinalsIndexFieldData

protected GlobalOrdinalsIndexFieldData(IndexSettings indexSettings,
                                       String fieldName,
                                       AtomicOrdinalsFieldData[] segmentAfd,
                                       OrdinalMap ordinalMap,
                                       long memorySizeInBytes,
                                       Function<SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Detail

newConsumer

public IndexOrdinalsFieldData newConsumer(DirectoryReader source)

loadDirect

public AtomicOrdinalsFieldData loadDirect(LeafReaderContext context)
                                   throws Exception

Description copied from interface: IndexFieldData

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

Specified by:

loadDirect in interface IndexFieldData<AtomicOrdinalsFieldData>

Throws:

Exception

loadGlobal

public IndexOrdinalsFieldData loadGlobal(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<AtomicOrdinalsFieldData>

Specified by:

loadGlobal in interface IndexOrdinalsFieldData

localGlobalDirect

public IndexOrdinalsFieldData localGlobalDirect(DirectoryReader indexReader)
                                         throws Exception

Description copied from interface: IndexOrdinalsFieldData

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

Specified by:

localGlobalDirect in interface IndexFieldData.Global<AtomicOrdinalsFieldData>

Specified by:

localGlobalDirect in interface IndexOrdinalsFieldData

Throws:

Exception

getFieldName

public String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<AtomicOrdinalsFieldData>

sortField

public SortField sortField(@Nullable
                           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<AtomicOrdinalsFieldData>

clear

public void clear()

Description copied from interface: IndexFieldData

Clears any resources associated with this field data.

Specified by:

clear in interface IndexFieldData<AtomicOrdinalsFieldData>

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Specified by:

getChildResources in interface Accountable

See Also:

Accountables

load

public AtomicOrdinalsFieldData load(LeafReaderContext context)

Description copied from interface: IndexFieldData

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

Specified by:

load in interface IndexFieldData<AtomicOrdinalsFieldData>

getOrdinalMap

public 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

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