Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class FieldMapper.Builder

java.lang.Object

org.elasticsearch.index.mapper.Mapper.Builder

org.elasticsearch.index.mapper.FieldMapper.Builder

All Implemented Interfaces:

ToXContent, ToXContentFragment

Direct Known Subclasses:

BinaryFieldMapper.Builder, CompletionFieldMapper.Builder, DateFieldMapper.Builder, DenseVectorFieldMapper.Builder, FieldMapper.DimensionBuilder, FieldMapper.TextFamilyBuilder, FlattenedFieldMapper.Builder, GeoPointFieldMapper.Builder, MetadataFieldMapper.Builder, PlaceHolderFieldMapper.Builder, RangeFieldMapper.Builder, SparseVectorFieldMapper.Builder

Enclosing class:

FieldMapper

public abstract static class FieldMapper.Builder
extends Mapper.Builder
implements ToXContentFragment

A Builder for a ParametrizedFieldMapper

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
protected FieldMapper.CopyTo	copyTo
protected boolean	hasScript
protected final FieldMapper.MultiFields.Builder	multiFieldsBuilder
protected OnScriptError	onScriptError
protected Optional<Mapper.SourceKeepMode>	sourceKeepMode

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String name)	Creates a new Builder with a field name

Method Summary

Modifier and Type	Method	Description
FieldMapper.Builder	addMultiField(FieldMapper.Builder builder)
protected void	addScriptValidation(FieldMapper.Parameter<Script> scriptParam, FieldMapper.Parameter<Boolean> indexParam, Supplier<Boolean> docValuesParam)
abstract FieldMapper	build(MapperBuilderContext context)	Returns a newly built mapper.
protected FieldMapper.BuilderParams	builderParams(Mapper.Builder mainFieldBuilder, MapperBuilderContext context)
abstract String	contentType()
protected abstract FieldMapper.Parameter<?>[]	getParameters()
protected void	handleUnknownParamOnLegacyIndex(String propName, Object propNode)
FieldMapper.Builder	init(FieldMapper initializer)	Initialises all parameters from an existing mapper
protected void	mergeFromBuilder(FieldMapper.Builder incoming, FieldMapper.Conflicts conflicts, MapperMergeContext mergeContext)
Mapper.Builder	mergeWith(Mapper.Builder incoming, MapperMergeContext mergeContext)	Merges an incoming builder into this builder.
final void	parse(String name, MappingParserContext parserContext, Map<String,Object> fieldNode)	Parse mapping parameters from a map of mappings
protected void	throwMergeTypeConflict(FieldMapper.Builder incoming, String fullName)	Throws an error when the incoming builder has a different class or content type.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Writes the current builder parameter values as XContent
protected final void	validate()

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

multiFieldsBuilder

protected final FieldMapper.MultiFields.Builder multiFieldsBuilder

copyTo

protected FieldMapper.CopyTo copyTo

sourceKeepMode

protected Optional<Mapper.SourceKeepMode> sourceKeepMode

hasScript

protected boolean hasScript

onScriptError

protected OnScriptError onScriptError

Constructor Details

Builder

protected Builder(String name)

Creates a new Builder with a field name

Method Details

init

public FieldMapper.Builder init(FieldMapper initializer)

Initialises all parameters from an existing mapper

addMultiField

public FieldMapper.Builder addMultiField(FieldMapper.Builder builder)

builderParams

protected FieldMapper.BuilderParams builderParams(Mapper.Builder mainFieldBuilder,
 MapperBuilderContext context)

validate

protected final void validate()

getParameters

protected abstract FieldMapper.Parameter<?>[] getParameters()

Returns:

the list of parameters defined for this mapper

contentType

public abstract String contentType()

Returns:

the content type name for this field mapper builder, matching the value returned by FieldMapper.contentType() on the built mapper

mergeWith

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

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

throwMergeTypeConflict

protected void throwMergeTypeConflict(FieldMapper.Builder incoming,
 String fullName)

Throws an error when the incoming builder has a different class or content type. Subclasses can override to provide more specific error messages.

mergeFromBuilder

protected void mergeFromBuilder(FieldMapper.Builder incoming,
 FieldMapper.Conflicts conflicts,
 MapperMergeContext mergeContext)

build

public abstract FieldMapper build(MapperBuilderContext context)

Description copied from class: Mapper.Builder

Returns a newly built mapper.

Specified by:

build in class Mapper.Builder

addScriptValidation

protected void addScriptValidation(FieldMapper.Parameter<Script> scriptParam,
 FieldMapper.Parameter<Boolean> indexParam,
 Supplier<Boolean> docValuesParam)

toXContent

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

Writes the current builder parameter values as XContent

Specified by:

toXContent in interface ToXContent

Throws:

IOException

parse

public final void parse(String name,
 MappingParserContext parserContext,
 Map<String,Object> fieldNode)

Parse mapping parameters from a map of mappings

Parameters:

name - the field mapper name

parserContext - the parser context

fieldNode - the root node of the map of mappings for this field

handleUnknownParamOnLegacyIndex

protected void handleUnknownParamOnLegacyIndex(String propName,
 Object propNode)