Package org.elasticsearch.index.fielddata.ordinals

Class GlobalOrdinalsIndexFieldData

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.fielddata.ordinals.GlobalOrdinalsIndexFieldData

All Implemented Interfaces:

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

public class GlobalOrdinalsIndexFieldData
extends AbstractIndexComponent
implements IndexOrdinalsFieldData, org.apache.lucene.util.Accountable

IndexFieldData base class for concrete global ordinals implementations.

Nested Class Summary

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, java.lang.String fieldName, AtomicOrdinalsFieldData[] segmentAfd, org.apache.lucene.index.OrdinalMap ordinalMap, long memorySizeInBytes, java.util.function.Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears any resources associated with this field data.
java.util.Collection<org.apache.lucene.util.Accountable>	getChildResources()
java.lang.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).
AtomicOrdinalsFieldData	load(org.apache.lucene.index.LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
AtomicOrdinalsFieldData	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	localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader.
long	ramBytesUsed()
org.apache.lucene.search.SortField	sortField(java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)	Returns the SortField to use for sorting.

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,
                                       java.lang.String fieldName,
                                       AtomicOrdinalsFieldData[] segmentAfd,
                                       org.apache.lucene.index.OrdinalMap ordinalMap,
                                       long memorySizeInBytes,
                                       java.util.function.Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Detail

loadDirect

public AtomicOrdinalsFieldData loadDirect(org.apache.lucene.index.LeafReaderContext context)
                                   throws java.lang.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:

java.lang.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<AtomicOrdinalsFieldData>

Specified by:

loadGlobal in interface IndexOrdinalsFieldData

localGlobalDirect

public IndexOrdinalsFieldData localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)
                                         throws java.lang.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:

java.lang.Exception

getFieldName

public java.lang.String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<AtomicOrdinalsFieldData>

sortField

public org.apache.lucene.search.SortField sortField(@Nullable
                                                    java.lang.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()

Specified by:

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

getChildResources

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

Specified by:

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

load

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

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