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 abstract 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.CommonSettings, IndexFieldData.Global<FD extends AtomicFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, index, indexSettings, logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobalOrdinalsIndexFieldData(Index index, Settings settings, MappedFieldType.Names fieldNames, FieldDataType fieldDataType, long memorySizeInBytes)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears any resources associated with this field data.
IndexFieldData.XFieldComparatorSource	comparatorSource(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested) Comparator used for sorting.
Collection<org.apache.lucene.util.Accountable>	getChildResources()
FieldDataType	getFieldDataType() The field data type.
MappedFieldType.Names	getFieldNames() The field name.
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()

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, indexSettings

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

load

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Constructor Detail

GlobalOrdinalsIndexFieldData

protected GlobalOrdinalsIndexFieldData(Index index,
                            Settings settings,
                            MappedFieldType.Names fieldNames,
                            FieldDataType fieldDataType,
                            long memorySizeInBytes)

Method Detail

loadDirect

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

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

Specified by:

loadGlobal in interface IndexOrdinalsFieldData

localGlobalDirect

public IndexOrdinalsFieldData localGlobalDirect(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:

localGlobalDirect in interface IndexFieldData.Global<AtomicOrdinalsFieldData>

Specified by:

localGlobalDirect in interface IndexOrdinalsFieldData

Throws:

Exception

getFieldNames

public MappedFieldType.Names getFieldNames()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldNames in interface IndexFieldData<AtomicOrdinalsFieldData>

getFieldDataType

public FieldDataType getFieldDataType()

Description copied from interface: IndexFieldData

The field data type.

Specified by:

getFieldDataType in interface IndexFieldData<AtomicOrdinalsFieldData>

comparatorSource

public IndexFieldData.XFieldComparatorSource comparatorSource(@Nullable
                                                     Object missingValue,
                                                     MultiValueMode sortMode,
                                                     IndexFieldData.XFieldComparatorSource.Nested nested)

Description copied from interface: IndexFieldData

Comparator used for sorting.

Specified by:

comparatorSource 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 Collection<org.apache.lucene.util.Accountable> getChildResources()

Specified by:

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