Package org.elasticsearch.index.mapper

Class ParametrizedFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.ParametrizedFieldMapper

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

Direct Known Subclasses:

BinaryFieldMapper, BooleanFieldMapper, CompletionFieldMapper, DateFieldMapper, IpFieldMapper, KeywordFieldMapper, MetadataFieldMapper, NumberFieldMapper, RangeFieldMapper, TextFieldMapper

public abstract class ParametrizedFieldMapper
extends FieldMapper

Defines how a particular field should be indexed and searched Configuration ParametrizedFieldMapper.Parameters for the mapper are defined on a ParametrizedFieldMapper.Builder subclass, and returned by its ParametrizedFieldMapper.Builder.getParameters() method. Merging, serialization and parsing of the mapper are all mediated through this set of parameters. Subclasses should implement a ParametrizedFieldMapper.Builder that is returned from the getMergeBuilder() method, initialised with the existing builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParametrizedFieldMapper.Builder	A Builder for a ParametrizedFieldMapper
static class	ParametrizedFieldMapper.Parameter<T>	A configurable parameter for a field mapper
protected static interface	ParametrizedFieldMapper.Serializer<T>	Serializes a parameter
protected static interface	ParametrizedFieldMapper.SerializerCheck<T>	Check on whether or not a parameter should be serialized
static class	ParametrizedFieldMapper.TypeParser	TypeParser implementation that automatically handles parsing

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

FieldMapper.CopyTo, FieldMapper.MultiFields

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper

Mapper.BuilderContext

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParametrizedFieldMapper(java.lang.String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)	Creates a new ParametrizedFieldMapper

Method Summary

Modifier and Type	Method	Description
protected void	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params)
abstract ParametrizedFieldMapper.Builder	getMergeBuilder()	Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
ParametrizedFieldMapper	merge(Mapper mergeWith)	Return the merge of mergeWith into this.
protected void	mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)	Merge type-specific options and check for incompatible settings in mappings to be merged

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper

clone, contentType, copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, fieldType, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parseCreateField, parsesArrayValue, storedByDefault, toXContent, typeName, validate

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

simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

ParametrizedFieldMapper

protected ParametrizedFieldMapper(java.lang.String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Creates a new ParametrizedFieldMapper

Method Details

getMergeBuilder

public abstract ParametrizedFieldMapper.Builder getMergeBuilder()

Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

merge

public final ParametrizedFieldMapper merge(Mapper mergeWith)

Description copied from class: Mapper

Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.

Overrides:

merge in class FieldMapper

mergeOptions

protected final void mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)

Description copied from class: FieldMapper

Merge type-specific options and check for incompatible settings in mappings to be merged

Specified by:

mergeOptions in class FieldMapper

doXContentBody

protected void doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Overrides:

doXContentBody in class FieldMapper

Throws:

java.io.IOException