Package org.opensearch.index.mapper

Class RootObjectMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.ObjectMapper

org.opensearch.index.mapper.RootObjectMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class RootObjectMapper
extends ObjectMapper

The root object mapper for a document

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RootObjectMapper.Builder	Builder for the root object
static class	RootObjectMapper.Defaults	Default parameters for root object
static class	RootObjectMapper.TypeParser	Type parser for the root object

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

ObjectMapper.Dynamic, ObjectMapper.Nested

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

Mapper.BuilderContext

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Field Summary

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

CONTENT_TYPE, NESTED_CONTENT_TYPE

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	dateDetection()
protected void	doMerge(ObjectMapper mergeWith, MapperService.MergeReason reason)
protected void	doXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
DateFormatter[]	dynamicDateTimeFormatters()
DynamicTemplate[]	dynamicTemplates()
DynamicTemplate	findTemplate(ContentPath path, String name, DynamicTemplate.XContentFieldType matchType)
Mapper.Builder	findTemplateBuilder(ParseContext context, String name, DateFormatter dateFormatter)
Mapper.Builder	findTemplateBuilder(ParseContext context, String name, DynamicTemplate.XContentFieldType matchType)
void	fixRedundantIncludes()	Removes redundant root includes in ObjectMapper.Nested trees to avoid duplicate fields on the root mapper when isIncludeInRoot is true for a node that is itself included into a parent node, for which either isIncludeInRoot is true or which is transitively included in root by a chain of nodes with isIncludeInParent returning true.
ObjectMapper	mappingUpdate(Mapper mapper)	Build a mapping update with the provided sub mapping update.
RootObjectMapper	merge(Mapper mergeWith, MapperService.MergeReason reason)
boolean	numericDetection()

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

clone, dynamic, fullPath, getMapper, getParentObjectMapper, isEnabled, iterator, merge, name, nested, nestedTypeFilter, nestedTypePath, parentObjectMapperAreNested, putMapper, toXContent, toXContent, typeName, validate

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

hasIndexCreated, simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Method Details

fixRedundantIncludes

public void fixRedundantIncludes()

Removes redundant root includes in ObjectMapper.Nested trees to avoid duplicate fields on the root mapper when isIncludeInRoot is true for a node that is itself included into a parent node, for which either isIncludeInRoot is true or which is transitively included in root by a chain of nodes with isIncludeInParent returning true.

mappingUpdate

public ObjectMapper mappingUpdate(Mapper mapper)

Description copied from class: ObjectMapper

Build a mapping update with the provided sub mapping update.

Overrides:

mappingUpdate in class ObjectMapper

dateDetection

public boolean dateDetection()

numericDetection

public boolean numericDetection()

dynamicDateTimeFormatters

public DateFormatter[] dynamicDateTimeFormatters()

dynamicTemplates

public DynamicTemplate[] dynamicTemplates()

findTemplateBuilder

public Mapper.Builder findTemplateBuilder(ParseContext context,
 String name,
 DynamicTemplate.XContentFieldType matchType)

findTemplateBuilder

public Mapper.Builder findTemplateBuilder(ParseContext context,
 String name,
 DateFormatter dateFormatter)

findTemplate

public DynamicTemplate findTemplate(ContentPath path,
 String name,
 DynamicTemplate.XContentFieldType matchType)

merge

public RootObjectMapper merge(Mapper mergeWith,
 MapperService.MergeReason reason)

Overrides:

merge in class ObjectMapper

doMerge

protected void doMerge(ObjectMapper mergeWith,
 MapperService.MergeReason reason)

Overrides:

doMerge in class ObjectMapper

doXContent

protected void doXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                   throws IOException

Overrides:

doXContent in class ObjectMapper

Throws:

IOException