Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class MetadataFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

Direct Known Subclasses:

DataStreamTimestampFieldMapper, DocCountFieldMapper, FieldNamesFieldMapper, IdFieldMapper, IgnoredFieldMapper, IndexFieldMapper, LegacyTypeFieldMapper, NestedPathFieldMapper, RoutingFieldMapper, SeqNoFieldMapper, SourceFieldMapper, TimeSeriesIdFieldMapper, TimeSeriesRoutingHashFieldMapper, VersionFieldMapper

public abstract class MetadataFieldMapper
extends FieldMapper

A mapper for a builtin field containing metadata about a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataFieldMapper.Builder
static class	MetadataFieldMapper.ConfigurableTypeParser
static class	MetadataFieldMapper.FixedTypeParser	A type parser for an unconfigurable metadata field.
static interface	MetadataFieldMapper.TypeParser

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

FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

COERCE_SETTING, copyTo, deprecationLogger, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataFieldMapper(MappedFieldType mappedFieldType)

Method Summary

Modifier and Type	Method	Description
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().
void	postParse(DocumentParserContext context)	Called after FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.
void	preParse(DocumentParserContext context)	Called before FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.
abstract SourceLoader.SyntheticFieldLoader	syntheticFieldLoader()	Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static FieldMapper.Parameter<Explicit<Boolean>>	updateableBoolParam(String name, Function<FieldMapper,Explicit<Boolean>> initializer, boolean defaultValue)	Declares an updateable boolean parameter for a metadata field We need to distinguish between explicit configuration and default value for metadata fields, because mapping updates will carry over the previous metadata values if a metadata field is not explicitly declared in the update.

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

checkIncomingMergeType, contentType, copyTo, doValidate, doXContentBody, executeScript, fieldType, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, name, notInMultiFields, parse, parsesArrayValue, sourcePathUsedBy, supportsParsingObject, typeName, validate

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

freezeAndDeduplicateFieldType, internFieldName, simpleName, 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

Constructor Details

MetadataFieldMapper

protected MetadataFieldMapper(MappedFieldType mappedFieldType)

Method Details

updateableBoolParam

public static FieldMapper.Parameter<Explicit<Boolean>> updateableBoolParam(String name,
 Function<FieldMapper,Explicit<Boolean>> initializer,
 boolean defaultValue)

Declares an updateable boolean parameter for a metadata field We need to distinguish between explicit configuration and default value for metadata fields, because mapping updates will carry over the previous metadata values if a metadata field is not explicitly declared in the update. A standard boolean parameter explicitly configured with a default value will not be serialized (as we do not serialize default parameters for mapping updates), and as such will be ignored by the update merge. Instead, we use an Explicit object that will serialize its value if it has been configured, no matter what the value is.

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

IOException

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

preParse

public void preParse(DocumentParserContext context)
              throws IOException

Called before FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.

Throws:

IOException

postParse

public void postParse(DocumentParserContext context)
               throws IOException

Called after FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.

Throws:

IOException

syntheticFieldLoader

public abstract SourceLoader.SyntheticFieldLoader syntheticFieldLoader()

Description copied from class: Mapper

Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.

Overrides:

syntheticFieldLoader in class Mapper