Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class ObjectMapper.Builder

java.lang.Object

org.elasticsearch.index.mapper.Mapper.Builder

org.elasticsearch.index.mapper.ObjectMapper.Builder

Direct Known Subclasses:

NestedObjectMapper.Builder, PassThroughObjectMapper.Builder, RootObjectMapper.Builder

Enclosing class:

ObjectMapper

public static class ObjectMapper.Builder
extends Mapper.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected ObjectMapper.Dynamic	dynamic
protected Explicit<Boolean>	enabled
protected final List<Mapper.Builder>	mappersBuilders
protected Optional<Mapper.SourceKeepMode>	sourceKeepMode
protected Explicit<ObjectMapper.Subobjects>	subobjects

Constructor Summary

Constructors

Constructor	Description
Builder(String name)
Builder(String name, Explicit<ObjectMapper.Subobjects> subobjects)

Method Summary

Modifier and Type	Method	Description
ObjectMapper.Builder	add(Mapper.Builder builder)
final void	addDynamic(String name, String prefix, Mapper.Builder mapperBuilder, DocumentParserContext context)	Adds a dynamically created Mapper.Builder to this builder.
ObjectMapper	build(MapperBuilderContext context)	Returns a newly built mapper.
protected final Map<String,Mapper>	buildMappers(MapperBuilderContext mapperBuilderContext)
ObjectMapper.Builder	dynamic(ObjectMapper.Dynamic dynamic)
ObjectMapper.Builder	enabled(boolean enabled)
List<Mapper.Builder>	getChildBuilders()
Mapper.Builder	mergeWith(Mapper.Builder incoming, MapperMergeContext parentContext)	Merges an incoming builder into this builder.
ObjectMapper.Builder	sourceKeepMode(Mapper.SourceKeepMode sourceKeepMode)

Methods inherited from class org.elasticsearch.index.mapper.Mapper.Builder

leafName

Methods inherited from class java.lang.Object

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

Field Details

subobjects

protected Explicit<ObjectMapper.Subobjects> subobjects

enabled

protected Explicit<Boolean> enabled

sourceKeepMode

protected Optional<Mapper.SourceKeepMode> sourceKeepMode

dynamic

protected ObjectMapper.Dynamic dynamic

mappersBuilders

protected final List<Mapper.Builder> mappersBuilders

Constructor Details

Builder

public Builder(String name)

Builder

public Builder(String name,
 Explicit<ObjectMapper.Subobjects> subobjects)

Method Details

enabled

public ObjectMapper.Builder enabled(boolean enabled)

sourceKeepMode

public ObjectMapper.Builder sourceKeepMode(Mapper.SourceKeepMode sourceKeepMode)

dynamic

public ObjectMapper.Builder dynamic(ObjectMapper.Dynamic dynamic)

add

public ObjectMapper.Builder add(Mapper.Builder builder)

addDynamic

public final void addDynamic(String name,
 String prefix,
 Mapper.Builder mapperBuilder,
 DocumentParserContext context)

Adds a dynamically created Mapper.Builder to this builder.

Parameters:

name - the name of the Mapper, including object prefixes

prefix - the object prefix of this mapper

mapperBuilder - the builder to add

context - the DocumentParserContext in which the mapper has been built

getChildBuilders

public List<Mapper.Builder> getChildBuilders()

buildMappers

protected final Map<String,Mapper> buildMappers(MapperBuilderContext mapperBuilderContext)

mergeWith

public Mapper.Builder mergeWith(Mapper.Builder incoming,
 MapperMergeContext parentContext)

Description copied from class: Mapper.Builder

Merges an incoming builder into this builder. Returns the merged builder, which may be a different instance if a type conversion is needed (e.g., ObjectMapper -> PassThroughObjectMapper).

Specified by:

mergeWith in class Mapper.Builder

build

public ObjectMapper build(MapperBuilderContext context)

Description copied from class: Mapper.Builder

Returns a newly built mapper.

Specified by:

build in class Mapper.Builder