org.elasticsearch.index.fielddata.plain

Class ParentChildIndexFieldData

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData<AtomicParentChildFieldData>

org.elasticsearch.index.fielddata.plain.ParentChildIndexFieldData

All Implemented Interfaces:

IndexFieldData<AtomicParentChildFieldData>, IndexFieldData.Global<AtomicParentChildFieldData>, IndexParentChildFieldData, IndexComponent, DocumentTypeListener

public class ParentChildIndexFieldData
extends AbstractIndexFieldData<AtomicParentChildFieldData>
implements IndexParentChildFieldData, DocumentTypeListener

ParentChildIndexFieldData is responsible for loading the id cache mapping needed for has_child and has_parent queries into memory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParentChildIndexFieldData.Builder
class	ParentChildIndexFieldData.GlobalFieldData
class	ParentChildIndexFieldData.ParentChildEstimator Estimator that wraps parent/child id field data by wrapping the data in a RamAccountingTermsEnum.

Nested classes/interfaces inherited from class org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData

AbstractIndexFieldData.PerValueEstimator

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

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

Field Summary

Fields inherited from class org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData

cache, fieldDataType

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, index, indexSettings, logger

Constructor Summary

Constructors

Constructor and Description
ParentChildIndexFieldData(Index index, Settings indexSettings, MappedFieldType.Names fieldNames, FieldDataType fieldDataType, IndexFieldDataCache cache, MapperService mapperService, CircuitBreakerService breakerService)

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeCreate(DocumentMapper mapper) Invoked just before a new document type has been created.
IndexFieldData.XFieldComparatorSource	comparatorSource(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested) Comparator used for sorting.
protected AtomicParentChildFieldData	empty(int maxDoc)
static org.apache.lucene.index.MultiDocValues.OrdinalMap	getOrdinalMap(IndexParentChildFieldData indexParentChildFieldData, String type) Returns the global ordinal map for the specified type
AtomicParentChildFieldData	load(org.apache.lucene.index.LeafReaderContext context) Loads the atomic field data for the reader, possibly cached.
org.elasticsearch.index.fielddata.plain.AbstractAtomicParentChildFieldData	loadDirect(org.apache.lucene.index.LeafReaderContext context) Loads directly the atomic field data for the reader, ignoring any caching involved.
IndexParentChildFieldData	loadGlobal(org.apache.lucene.index.DirectoryReader indexReader) Load a global view of the ordinals for the given IndexReader, potentially from a cache.
IndexParentChildFieldData	localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader) Load a global view of the ordinals for the given IndexReader.

Methods inherited from class org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData

clear, getFieldDataType, getFieldNames

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

clear, getFieldDataType, getFieldNames

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Constructor Detail

ParentChildIndexFieldData

public ParentChildIndexFieldData(Index index,
                         Settings indexSettings,
                         MappedFieldType.Names fieldNames,
                         FieldDataType fieldDataType,
                         IndexFieldDataCache cache,
                         MapperService mapperService,
                         CircuitBreakerService breakerService)

Method Detail

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

load

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

Overrides:

load in class AbstractIndexFieldData<AtomicParentChildFieldData>

loadDirect

public org.elasticsearch.index.fielddata.plain.AbstractAtomicParentChildFieldData 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<AtomicParentChildFieldData>

Throws:

Exception

beforeCreate

public void beforeCreate(DocumentMapper mapper)

Description copied from interface: DocumentTypeListener

Invoked just before a new document type has been created.

Specified by:

beforeCreate in interface DocumentTypeListener

Parameters:

mapper - The new document mapper of the type being added

empty

protected AtomicParentChildFieldData empty(int maxDoc)

Specified by:

empty in class AbstractIndexFieldData<AtomicParentChildFieldData>

Parameters:

maxDoc - of the current reader

Returns:

an empty field data instances for field data lookups of empty segments (returning no values)

loadGlobal

public IndexParentChildFieldData loadGlobal(org.apache.lucene.index.DirectoryReader indexReader)

Description copied from interface: IndexParentChildFieldData

Load a global view of the ordinals for the given IndexReader, potentially from a cache.

Specified by:

loadGlobal in interface IndexFieldData.Global<AtomicParentChildFieldData>

Specified by:

loadGlobal in interface IndexParentChildFieldData

localGlobalDirect

public IndexParentChildFieldData localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)
                                            throws Exception

Description copied from interface: IndexParentChildFieldData

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

Specified by:

localGlobalDirect in interface IndexFieldData.Global<AtomicParentChildFieldData>

Specified by:

localGlobalDirect in interface IndexParentChildFieldData

Throws:

Exception

getOrdinalMap

public static org.apache.lucene.index.MultiDocValues.OrdinalMap getOrdinalMap(IndexParentChildFieldData indexParentChildFieldData,
                                                              String type)

Returns the global ordinal map for the specified type