Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class ObjectMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.ObjectMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

Direct Known Subclasses:

NestedObjectMapper, PassThroughObjectMapper, RootObjectMapper

public class ObjectMapper
extends Mapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectMapper.Builder
static class	ObjectMapper.Defaults
static enum	ObjectMapper.Dynamic
protected static final record	ObjectMapper.MergeResult
static enum	ObjectMapper.Subobjects	Enhances the previously boolean option for subobjects support with an intermediate mode `auto` that uses any objects that are present in the mappings and flattens any fields defined outside the predefined objects.
static class	ObjectMapper.TypeParser

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

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
protected final ObjectMapper.Dynamic	dynamic
protected final Explicit<Boolean>	enabled
protected final Map<String,Mapper>	mappers
protected final Optional<Mapper.SourceKeepMode>	sourceKeepMode
static final FeatureFlag	SUB_OBJECTS_AUTO_FEATURE_FLAG
protected final Optional<ObjectMapper.Subobjects>	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
protected MapperMergeContext	createChildContext(MapperMergeContext mapperMergeContext, String name)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
final ObjectMapper.Dynamic	dynamic()
ObjectMapper	findParentMapper(String leafFieldPath)
String	fullPath()	Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
Mapper	getMapper(String field)
int	getTotalFieldsCount()	The total number of fields as defined in the mapping.
boolean	isEnabled()
boolean	isNested()
protected boolean	isRoot()
Iterator<Mapper>	iterator()
ObjectMapper	merge(Mapper mergeWith, MapperMergeContext parentMergeContext)	Return the merge of mergeWith into this.
ObjectMapper.Builder	newBuilder(IndexVersion indexVersionCreated)
protected void	serializeMappers(XContentBuilder builder, ToXContent.Params params)
final Optional<Mapper.SourceKeepMode>	sourceKeepMode()
final ObjectMapper.Subobjects	subobjects()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	typeName()	Returns a name representing the type of this mapper.
void	validate(MappingLookup mappers)	Validate any cross-field references made by this mapper

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

freezeAndDeduplicateFieldType, internFieldName, leafName, 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.xcontent.ToXContentFragment

isFragment

Field Details

SUB_OBJECTS_AUTO_FEATURE_FLAG

public static final FeatureFlag SUB_OBJECTS_AUTO_FEATURE_FLAG

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

enabled

protected final Explicit<Boolean> enabled

subobjects

protected final Optional<ObjectMapper.Subobjects> subobjects

sourceKeepMode

protected final Optional<Mapper.SourceKeepMode> sourceKeepMode

dynamic

protected final ObjectMapper.Dynamic dynamic

mappers

protected final Map<String,Mapper> mappers

Method Details

getTotalFieldsCount

public int getTotalFieldsCount()

Description copied from class: Mapper

The total number of fields as defined in the mapping. Defines how this mapper counts towards MapperService.INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING.

Specified by:

getTotalFieldsCount in class Mapper

newBuilder

public ObjectMapper.Builder newBuilder(IndexVersion indexVersionCreated)

Returns:

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

fullPath

public String fullPath()

Description copied from class: Mapper

Returns the canonical name which uniquely identifies the mapper against other mappers in a type.

Specified by:

fullPath in class Mapper

typeName

public String typeName()

Description copied from class: Mapper

Returns a name representing the type of this mapper.

Specified by:

typeName in class Mapper

isEnabled

public boolean isEnabled()

isNested

public boolean isNested()

getMapper

public Mapper getMapper(String field)

iterator

public Iterator<Mapper> iterator()

dynamic

public final ObjectMapper.Dynamic dynamic()

subobjects

public final ObjectMapper.Subobjects subobjects()

sourceKeepMode

public final Optional<Mapper.SourceKeepMode> sourceKeepMode()

validate

public void validate(MappingLookup mappers)

Description copied from class: Mapper

Validate any cross-field references made by this mapper

Specified by:

validate in class Mapper

Parameters:

mappers - a MappingLookup that can produce references to other mappers

createChildContext

protected MapperMergeContext createChildContext(MapperMergeContext mapperMergeContext,
 String name)

merge

public ObjectMapper merge(Mapper mergeWith,
 MapperMergeContext parentMergeContext)

Description copied from class: Mapper

Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.

Specified by:

merge in class Mapper

toXContent

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

Throws:

IOException

serializeMappers

protected void serializeMappers(XContentBuilder builder,
 ToXContent.Params params)
                         throws IOException

Throws:

IOException

doXContent

protected void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                   throws IOException

Throws:

IOException

findParentMapper

public ObjectMapper findParentMapper(String leafFieldPath)

isRoot

protected boolean isRoot()