Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class PassThroughObjectMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.ObjectMapper

org.elasticsearch.index.mapper.PassThroughObjectMapper

All Implemented Interfaces:

Iterable<Mapper>, PassThroughFieldSource, ToXContent, ToXContentFragment

public final class PassThroughObjectMapper
extends ObjectMapper
implements PassThroughFieldSource

Mapper for pass-through objects. Pass-through objects allow creating fields inside them that can also be referenced directly in search queries. They also include parameters that affect how nested fields get configured. For instance, if parameter "time_series_dimension" is set, eligible subfields are marked as dimensions and keyword fields are additionally included in routing and tsid calculations. In case different pass-through objects contain subfields with the same name (excluding the pass-through prefix), their aliases conflict. To resolve this, the pass-through spec specifies which object takes precedence through required parameter "priority"; non-negative integer values are accepted, with the highest priority value winning in case of conflicting aliases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PassThroughObjectMapper.Builder
static class	PassThroughObjectMapper.TypeParser

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.ObjectMapper

ObjectMapper.Defaults, ObjectMapper.Dynamic, ObjectMapper.Subobjects

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper

Mapper.IgnoreAbove, Mapper.SourceKeepMode

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	PRIORITY_PARAM_NAME

Fields inherited from class org.elasticsearch.index.mapper.ObjectMapper

dynamic, enabled, mappers, sourceKeepMode, subobjects

Fields inherited from class org.elasticsearch.index.mapper.Mapper

SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static void	checkForDuplicatePriorities(Collection<? extends PassThroughFieldSource> passThroughSources)	Checks the passed sources for duplicate priorities.
boolean	containsDimensions()
PassThroughObjectMapper.Builder	newBuilder(IndexVersion indexVersionCreated)
Collection<FieldMapper>	passThroughSubFields()	The set of sub-field mappers whose Mapper.leafName() should be registered as root-level aliases.
int	priority()	The non-negative priority used to resolve conflicts when multiple passthrough sources expose sub-fields with the same leaf name at the root level.
Explicit<Boolean>	timeSeriesDimensionSubFields()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	typeName()	Returns a name representing the type of this mapper.

Methods inherited from class org.elasticsearch.index.mapper.ObjectMapper

doXContent, dynamic, findParentMapper, fullPath, getMapper, getTotalFieldsCount, isEnabled, isNested, isRoot, iterator, serializeMappers, sourceKeepMode, subobjects, validate, validateSubField

Methods inherited from class org.elasticsearch.index.mapper.Mapper

freezeAndDeduplicateFieldType, getOffsetFieldName, internFieldName, leafName, supportStoringArrayOffsets, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.index.mapper.PassThroughFieldSource

fullPath

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PRIORITY_PARAM_NAME

public static final String PRIORITY_PARAM_NAME

See Also:

• Constant Field Values

Method Details

typeName

public String typeName()

Description copied from class: Mapper

Returns a name representing the type of this mapper.

Overrides:

typeName in class ObjectMapper

containsDimensions

public boolean containsDimensions()

priority

public int priority()

Description copied from interface: PassThroughFieldSource

The non-negative priority used to resolve conflicts when multiple passthrough sources expose sub-fields with the same leaf name at the root level. Higher priority wins.

Specified by:

priority in interface PassThroughFieldSource

passThroughSubFields

public Collection<FieldMapper> passThroughSubFields()

Description copied from interface: PassThroughFieldSource

The set of sub-field mappers whose Mapper.leafName() should be registered as root-level aliases. Returns an empty collection when passthrough is disabled or there are no eligible sub-fields.

Specified by:

passThroughSubFields in interface PassThroughFieldSource

timeSeriesDimensionSubFields

public Explicit<Boolean> timeSeriesDimensionSubFields()

newBuilder

public PassThroughObjectMapper.Builder newBuilder(IndexVersion indexVersionCreated)

Overrides:

newBuilder in class ObjectMapper

Returns:

a Builder that will produce an empty ObjectMapper with the same configuration as this one

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class ObjectMapper

Throws:

IOException

checkForDuplicatePriorities

public static void checkForDuplicatePriorities(Collection<? extends PassThroughFieldSource> passThroughSources)

Checks the passed sources for duplicate priorities.

Parameters:

passThroughSources - sources to check