Package org.elasticsearch.index.fielddata.ordinals

Class GlobalOrdinalsIndexFieldData

java.lang.Object

org.elasticsearch.index.fielddata.ordinals.GlobalOrdinalsIndexFieldData

All Implemented Interfaces:

org.apache.lucene.util.Accountable, IndexFieldData<LeafOrdinalsFieldData>, IndexFieldData.Global<LeafOrdinalsFieldData>, IndexOrdinalsFieldData

public final class GlobalOrdinalsIndexFieldData
extends Object
implements IndexOrdinalsFieldData, org.apache.lucene.util.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 LeafFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GlobalOrdinalsIndexFieldData(String fieldName, ValuesSourceType valuesSourceType, LeafOrdinalsFieldData[] segmentAfd, org.apache.lucene.index.OrdinalMap ordinalMap, long memorySizeInBytes, Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Summary

Modifier and Type	Method	Description
Collection<org.apache.lucene.util.Accountable>	getChildResources()
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.
LeafOrdinalsFieldData	loadDirect(org.apache.lucene.index.LeafReaderContext context)	Loads directly the atomic field data for the reader, ignoring any caching involved.
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.
BucketedSort	newBucketedSort(BigArrays bigArrays, Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, SortOrder sortOrder, DocValueFormat format, int bucketSize, BucketedSort.ExtraData extra)	Build a sort implementation specialized for aggregations.
IndexOrdinalsFieldData	newConsumer(org.apache.lucene.index.DirectoryReader source)
long	ramBytesUsed()
org.apache.lucene.search.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 java.lang.Object

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

Constructor Details

GlobalOrdinalsIndexFieldData

protected GlobalOrdinalsIndexFieldData(String fieldName,
 ValuesSourceType valuesSourceType,
 LeafOrdinalsFieldData[] segmentAfd,
 org.apache.lucene.index.OrdinalMap ordinalMap,
 long memorySizeInBytes,
 Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Details

newConsumer

public IndexOrdinalsFieldData newConsumer(org.apache.lucene.index.DirectoryReader source)

loadDirect

public LeafOrdinalsFieldData loadDirect(org.apache.lucene.index.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<LeafOrdinalsFieldData>

Throws:

Exception

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

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>

sortField

public org.apache.lucene.search.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<LeafOrdinalsFieldData>

newBucketedSort

public BucketedSort newBucketedSort(BigArrays bigArrays,
 Object missingValue,
 MultiValueMode sortMode,
 IndexFieldData.XFieldComparatorSource.Nested nested,
 SortOrder sortOrder,
 DocValueFormat format,
 int bucketSize,
 BucketedSort.ExtraData extra)

Description copied from interface: IndexFieldData

Build a sort implementation specialized for aggregations.

Specified by:

newBucketedSort in interface IndexFieldData<LeafOrdinalsFieldData>

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

getChildResources

public Collection<org.apache.lucene.util.Accountable> getChildResources()

Specified by:

getChildResources in interface org.apache.lucene.util.Accountable

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>

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

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