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.Parameter
s 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 ParametrizedFieldMapperstatic class
ParametrizedFieldMapper.Parameter<T>
A configurable parameter for a field mapperprotected static interface
ParametrizedFieldMapper.Serializer<T>
Serializes a parameterprotected static interface
ParametrizedFieldMapper.SerializerCheck<T>
Check on whether or not a parameter should be serializedstatic class
ParametrizedFieldMapper.TypeParser
TypeParser implementation that automatically handles parsingNested 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
-
Field Summary
Fields inherited from class org.elasticsearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields
-
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 aParametrizedFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
ParametrizedFieldMapper
merge(Mapper mergeWith)
Return the merge ofmergeWith
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 mergedMethods 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
-
Constructor Details
-
ParametrizedFieldMapper
protected ParametrizedFieldMapper(java.lang.String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)Creates a new ParametrizedFieldMapper
-
-
Method Details
-
getMergeBuilder
Returns aParametrizedFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
-
merge
Description copied from class:Mapper
Return the merge ofmergeWith
into this. Boththis
andmergeWith
will be left unmodified.- Overrides:
merge
in classFieldMapper
-
mergeOptions
Description copied from class:FieldMapper
Merge type-specific options and check for incompatible settings in mappings to be merged- Specified by:
mergeOptions
in classFieldMapper
-
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 classFieldMapper
- Throws:
java.io.IOException
-