Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class PlaceHolderFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.PlaceHolderFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class PlaceHolderFieldMapper
extends FieldMapper

Mapper that is used to map existing fields in legacy indices (older than N-1) that the current version of ES can't access anymore. Mapping these fields is important so that the original mapping can be preserved and proper exception messages can be provided when accessing these fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlaceHolderFieldMapper.Builder
static final class	PlaceHolderFieldMapper.PlaceHolderFieldType

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

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TypeParser

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

Mapper.SourceKeepMode

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<String,FieldMapper.TypeParser>	PARSER
protected final Map<String,Object>	unknownParams

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

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

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

SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PlaceHolderFieldMapper(String simpleName, PlaceHolderFieldMapper.PlaceHolderFieldType fieldType, FieldMapper.BuilderParams builderParams, Map<String,Object> unknownParams)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().

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

checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doValidate, doXContentBody, executeScript, fieldType, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, syntheticSourceSupport, toXContent, typeName, validate

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

freezeAndDeduplicateFieldType, internFieldName, leafName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

PARSER

public static final Function<String,FieldMapper.TypeParser> PARSER

unknownParams

protected final Map<String,Object> unknownParams

Constructor Details

PlaceHolderFieldMapper

public PlaceHolderFieldMapper(String simpleName,
 PlaceHolderFieldMapper.PlaceHolderFieldType fieldType,
 FieldMapper.BuilderParams builderParams,
 Map<String,Object> unknownParams)

Method Details

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

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

Specified by:

getMergeBuilder in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper