org.elasticsearch.index.mapper

Class Mapping

java.lang.Object

org.elasticsearch.index.mapper.Mapping

All Implemented Interfaces:

ToXContent

public final class Mapping
extends Object
implements ToXContent

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Mapping.SourceTransform Transformations to be applied to the source before indexing and/or after loading.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	LEGACY_INCLUDE_IN_OBJECT

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Mapping(Version indexCreated, RootObjectMapper rootObjectMapper, MetadataFieldMapper[] metadataMappers, Mapping.SourceTransform[] sourceTransforms, com.google.common.collect.ImmutableMap<String,Object> meta)

Method Summary

Methods

Modifier and Type	Method and 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(Class<T> clazz) Get the root mapper with the given class.
RootObjectMapper	root() Return the root object mapper.
BytesReference	toBytes() Serialize to a BytesReference.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Mapping	updateFieldType(Map<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

Field Detail

LEGACY_INCLUDE_IN_OBJECT

public static final Set<String> LEGACY_INCLUDE_IN_OBJECT

Constructor Detail

Mapping

public Mapping(Version indexCreated,
       RootObjectMapper rootObjectMapper,
       MetadataFieldMapper[] metadataMappers,
       Mapping.SourceTransform[] sourceTransforms,
       com.google.common.collect.ImmutableMap<String,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(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(Map<String,MappedFieldType> fullNameToFieldType)

Recursively update sub field types.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toBytes

public BytesReference toBytes()

Serialize to a BytesReference.

toString

public String toString()

Overrides:

toString in class Object