Package org.opensearch.index.mapper

Class MetadataFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.MetadataFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

Direct Known Subclasses:

DataStreamFieldMapper, DocCountFieldMapper, FieldNamesFieldMapper, IdFieldMapper, IgnoredFieldMapper, IndexFieldMapper, NestedPathFieldMapper, RoutingFieldMapper, SeqNoFieldMapper, SourceFieldMapper, VersionFieldMapper

@PublicApi(since="1.0.0")
public abstract class MetadataFieldMapper
extends ParametrizedFieldMapper

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

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataFieldMapper.Builder	Base builder for internal metadata fields
static class	MetadataFieldMapper.ConfigurableTypeParser	Type parser that is configurable
static class	MetadataFieldMapper.FixedTypeParser	A type parser for an unconfigurable metadata field.
static interface	MetadataFieldMapper.TypeParser	Type parser for the field mapper

Nested classes/interfaces inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

ParametrizedFieldMapper.Parameter<T>, ParametrizedFieldMapper.Serializer<T>, ParametrizedFieldMapper.SerializerCheck<T>

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

FieldMapper.CopyTo, FieldMapper.MultiFields

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

Mapper.BuilderContext

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

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

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataFieldMapper(MappedFieldType mappedFieldType)

Method Summary

Modifier and Type	Method	Description
ParametrizedFieldMapper.Builder	getMergeBuilder()	Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization
protected void	parseCreateField(ParseContext context)	Parse the field value and populate the fields on ParseContext.doc().
void	postParse(ParseContext context)	Called after FieldMapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context)	Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.
final org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static ParametrizedFieldMapper.Parameter<org.opensearch.common.Explicit<Boolean>>	updateableBoolParam(String name, Function<FieldMapper,org.opensearch.common.Explicit<Boolean>> initializer, boolean defaultValue)	Declares an updateable boolean parameter for a metadata field

Methods inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

doXContentBody, merge, mergeOptions

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

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

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

hasIndexCreated, 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.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

MetadataFieldMapper

protected MetadataFieldMapper(MappedFieldType mappedFieldType)

Method Details

updateableBoolParam

public static ParametrizedFieldMapper.Parameter<org.opensearch.common.Explicit<Boolean>> updateableBoolParam(String name,
 Function<FieldMapper,org.opensearch.common.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 ParametrizedFieldMapper.Builder getMergeBuilder()

Description copied from class: ParametrizedFieldMapper

Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization

Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class ParametrizedFieldMapper

toXContent

public final org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                              throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on ParseContext.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(ParseContext context)
              throws IOException

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

Throws:

IOException

postParse

public void postParse(ParseContext context)
               throws IOException

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

Throws:

IOException