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 class	ObjectMapper.TypeParser

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 Explicit<Boolean>	subobjects

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()
String	fullPath()
Mapper	getMapper(String field)
int	getTotalFieldsCount()	The total number of fields as defined in the mapping.
boolean	isEnabled()
boolean	isNested()
Iterator<Mapper>	iterator()
ObjectMapper	merge(Mapper mergeWith, MapperMergeContext mapperMergeContext)	Return the merge of mergeWith into this.
ObjectMapper	merge(Mapper mergeWith, MapperService.MergeReason reason, MapperMergeContext parentMergeContext)
String	name()	Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
ObjectMapper.Builder	newBuilder(IndexVersion indexVersionCreated)
protected void	serializeMappers(XContentBuilder builder, ToXContent.Params params)
protected void	startSyntheticField(XContentBuilder b)
final boolean	subobjects()
SourceLoader.SyntheticFieldLoader	syntheticFieldLoader()	Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.
SourceLoader.SyntheticFieldLoader	syntheticFieldLoader(Stream<Mapper> extra)
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, simpleName, 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

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

enabled

protected final Explicit<Boolean> enabled

subobjects

protected final Explicit<Boolean> subobjects

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

name

public String name()

Description copied from class: Mapper

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

Specified by:

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

fullPath

public String fullPath()

dynamic

public final ObjectMapper.Dynamic dynamic()

subobjects

public final boolean subobjects()

merge

public ObjectMapper merge(Mapper mergeWith,
 MapperMergeContext mapperMergeContext)

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

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,
 MapperService.MergeReason reason,
 MapperMergeContext parentMergeContext)

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

syntheticFieldLoader

public SourceLoader.SyntheticFieldLoader syntheticFieldLoader(Stream<Mapper> extra)

syntheticFieldLoader

public SourceLoader.SyntheticFieldLoader syntheticFieldLoader()

Description copied from class: Mapper

Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.

Overrides:

syntheticFieldLoader in class Mapper

startSyntheticField

protected void startSyntheticField(XContentBuilder b)
                            throws IOException

Throws:

IOException