Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class MappingBuilder

java.lang.Object

org.elasticsearch.index.mapper.MappingBuilder

public class MappingBuilder
extends Object

Mutable builder for a Mapping. Holds a RootObjectMapper.Builder and metadata field builders, allowing merge operations to happen at the builder level before building the final immutable Mapping.

Constructor Summary

Constructors

Constructor	Description
MappingBuilder(RootObjectMapper.Builder rootBuilder, Map<String,MetadataFieldMapper.Builder> metadataBuilders, Map<String,Object> meta)

Method Summary

Modifier and Type	Method	Description
Mapping	build(MapperService.MergeReason reason)	Builds the final immutable Mapping from the current builder state.
void	merge(MappingBuilder incoming, MapperService.MergeReason reason, long newFieldsBudget)	Merges another MappingBuilder into this one, mutating this builder in place.
MetadataFieldMapper.Builder	metadataBuilder(String name)
RootObjectMapper.Builder	rootBuilder()

Methods inherited from class java.lang.Object

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

Constructor Details

MappingBuilder

public MappingBuilder(RootObjectMapper.Builder rootBuilder,
 Map<String,MetadataFieldMapper.Builder> metadataBuilders,
 @Nullable
 Map<String,Object> meta)

Method Details

rootBuilder

public RootObjectMapper.Builder rootBuilder()

metadataBuilder

public MetadataFieldMapper.Builder metadataBuilder(String name)

merge

public void merge(MappingBuilder incoming,
 MapperService.MergeReason reason,
 long newFieldsBudget)

Merges another MappingBuilder into this one, mutating this builder in place.

Parameters:

incoming - the incoming mapping builder to merge

reason - the reason for the merge

newFieldsBudget - how many new fields may be added during the merge

build

public Mapping build(MapperService.MergeReason reason)

Builds the final immutable Mapping from the current builder state.

Parameters:

reason - the merge reason, used to configure the MapperBuilderContext for building

Returns:

the built Mapping