Package org.elasticsearch.index.mapper.flattened

Class FlattenedFieldMapper.KeyedFlattenedFieldData

java.lang.Object

org.elasticsearch.index.mapper.flattened.FlattenedFieldMapper.KeyedFlattenedFieldData

All Implemented Interfaces:

IndexFieldData<LeafOrdinalsFieldData>, IndexFieldData.Global<LeafOrdinalsFieldData>, IndexOrdinalsFieldData

Enclosing class:

FlattenedFieldMapper

public static class FlattenedFieldMapper.KeyedFlattenedFieldData
extends Object
implements IndexOrdinalsFieldData

A field data implementation that gives access to the values associated with a particular JSON key. This class wraps the field data that is built directly on the keyed flattened field, and filters out values whose prefix doesn't match the requested key. Loading and caching is fully delegated to the wrapped field data, so that different FlattenedFieldMapper.KeyedFlattenedFieldData for the same flattened field share the same global ordinals. Because of the code-level complexity it would introduce, it is currently not possible to retrieve the underlying global ordinals map through getOrdinalMap().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlattenedFieldMapper.KeyedFlattenedFieldData.Builder

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

IndexFieldData.Global<FD extends LeafFieldData>, IndexFieldData.XFieldComparatorSource

Method Summary

Modifier and Type	Method	Description
String	getFieldName()	The field name.
String	getKey()
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.
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

Method Details

getKey

public String getKey()

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

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>

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

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