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 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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final Mapping	EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Mapping(RootObjectMapper rootObjectMapper, MetadataFieldMapper[] metadataMappers, Map<String,Object> meta)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getMeta()	Returns the meta section for the current mapping
<T extends MetadataFieldMapper> T	getMetadataMapperByClass(Class<T> clazz)	Get the metadata mapper with the given class.
Mapping	merge(Mapping mergeWith, MapperService.MergeReason reason)	Merges a new mapping into the existing one.
CompressedXContent	toCompressedXContent()	Outputs this mapping instance and returns it in CompressedXContent format
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

EMPTY

public static final Mapping EMPTY

Constructor Details

Mapping

public Mapping(RootObjectMapper rootObjectMapper,
 MetadataFieldMapper[] metadataMappers,
 Map<String,Object> meta)

Method Details

toCompressedXContent

public CompressedXContent toCompressedXContent()

Outputs this mapping instance and returns it in CompressedXContent format

Returns:

the CompressedXContent representation of this mapping instance

type

public String type()

getMeta

public Map<String,Object> getMeta()

Returns the meta section for the current mapping

getMetadataMapperByClass

public <T extends MetadataFieldMapper> T getMetadataMapperByClass(Class<T> clazz)

Get the metadata mapper with the given class.

merge

public Mapping merge(Mapping mergeWith,
 MapperService.MergeReason reason)

Merges a new mapping into the existing one.

Parameters:

mergeWith - the new mapping to merge into this one.

reason - the reason this merge was initiated.

Returns:

the resulting merged mapping.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object