Package org.elasticsearch.index.mapper

Class Mapping

java.lang.Object

org.elasticsearch.index.mapper.Mapping

All Implemented Interfaces:

ToXContent, ToXContentFragment

public final class Mapping
extends java.lang.Object
implements ToXContentFragment

Wrapper around everything that defines a mapping, without references to utility classes like MapperService, ...

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Mapping(Version indexCreated, RootObjectMapper rootObjectMapper, MetadataFieldMapper[] metadataMappers, java.util.Map<java.lang.String,java.lang.Object> meta)

Method Summary

Modifier and Type	Method	Description
Mapping	mappingUpdate(Mapper rootObjectMapper)	Generate a mapping update for the given root object mapper.
Mapping	merge(Mapping mergeWith, boolean updateAllTypes)
<T extends MetadataFieldMapper> T	metadataMapper(java.lang.Class<T> clazz)	Get the root mapper with the given class.
RootObjectMapper	root()	Return the root object mapper.
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Mapping	updateFieldType(java.util.Map<java.lang.String,MappedFieldType> fullNameToFieldType)	Recursively update sub field types.

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

Mapping

public Mapping(Version indexCreated,
               RootObjectMapper rootObjectMapper,
               MetadataFieldMapper[] metadataMappers,
               java.util.Map<java.lang.String,java.lang.Object> meta)

Method Detail

root

public RootObjectMapper root()

Return the root object mapper.

mappingUpdate

public Mapping mappingUpdate(Mapper rootObjectMapper)

Generate a mapping update for the given root object mapper.

metadataMapper

public <T extends MetadataFieldMapper> T metadataMapper(java.lang.Class<T> clazz)

Get the root mapper with the given class.

merge

public Mapping merge(Mapping mergeWith,
                     boolean updateAllTypes)

See Also:

DocumentMapper.merge(Mapping, boolean)

updateFieldType

public Mapping updateFieldType(java.util.Map<java.lang.String,MappedFieldType> fullNameToFieldType)

Recursively update sub field types.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object