org.elasticsearch.index.fielddata

Class UidIndexFieldData

java.lang.Object

org.elasticsearch.index.fielddata.UidIndexFieldData

All Implemented Interfaces:

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

public final class UidIndexFieldData
extends java.lang.Object
implements IndexOrdinalsFieldData

Fielddata view of the _uid field on indices that do not index _uid but _id. It gets fielddata on the _id field, which is in-memory since the _id field does not have doc values, and prepends ${type}# to all values. Note that it does not add memory compared to what fielddata on the _id is already using: this is just a view. TODO: Remove fielddata access on _uid and _id, or add doc values to _id.

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

Constructor Summary

Constructors

Constructor and Description
UidIndexFieldData(Index index, java.lang.String type, IndexOrdinalsFieldData idFieldData)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears any resources associated with this field data.
java.lang.String	getFieldName() The field name.
org.apache.lucene.index.MultiDocValues.OrdinalMap	getOrdinalMap() Returns the underlying MultiDocValues.OrdinalMap for this fielddata or null if global ordinals are not needed (constant value or single segment).
Index	index()
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.
org.apache.lucene.search.SortField	sortField(java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse) Returns the SortField to used for sorting.

Methods inherited from class java.lang.Object

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

Constructor Detail

UidIndexFieldData

public UidIndexFieldData(Index index,
                         java.lang.String type,
                         IndexOrdinalsFieldData idFieldData)

Method Detail

index

public Index index()

Specified by:

index in interface IndexComponent

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(java.lang.Object missingValue,
                                                    MultiValueMode sortMode,
                                                    IndexFieldData.XFieldComparatorSource.Nested nested,
                                                    boolean reverse)

Description copied from interface: IndexFieldData

Returns the SortField to used for sorting.

Specified by:

sortField in interface IndexFieldData<AtomicOrdinalsFieldData>

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>

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

clear

public void clear()

Description copied from interface: IndexFieldData

Clears any resources associated with this field data.

Specified by:

clear in interface IndexFieldData<AtomicOrdinalsFieldData>

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

getOrdinalMap

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

Description copied from interface: IndexOrdinalsFieldData

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

Specified by:

getOrdinalMap in interface IndexOrdinalsFieldData