Package org.opensearch.index.mapper

Class DerivedFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.DerivedFieldMapper

All Implemented Interfaces:

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

public class DerivedFieldMapper
extends ParametrizedFieldMapper

A field mapper for derived fields

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DerivedFieldMapper.Builder	Builder for this field mapper

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

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

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

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
protected final IndexAnalyzers	indexAnalyzers
static final ParametrizedFieldMapper.TypeParser	PARSER

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	DerivedFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, DerivedFieldMapper.Builder builder, IndexAnalyzers indexAnalyzers, DateFormatter defaultDateFormatter, boolean ignoreMalformed)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
protected void	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, boolean includeDefaults, org.opensearch.core.xcontent.ToXContent.Params params)
DerivedFieldType	fieldType()
ParametrizedFieldMapper.Builder	getMergeBuilder()	Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization
Script	getScript()
String	getType()
protected void	parseCreateField(ParseContext context)	Parse the field value and populate the fields on ParseContext.doc().

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

merge, mergeOptions

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

clone, copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parsesArrayValue, storedByDefault, toXContent, 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

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

indexAnalyzers

protected final IndexAnalyzers indexAnalyzers

PARSER

public static final ParametrizedFieldMapper.TypeParser PARSER

Constructor Details

DerivedFieldMapper

protected DerivedFieldMapper(String simpleName,
 MappedFieldType mappedFieldType,
 FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo,
 DerivedFieldMapper.Builder builder,
 IndexAnalyzers indexAnalyzers,
 DateFormatter defaultDateFormatter,
 boolean ignoreMalformed)

Method Details

fieldType

public DerivedFieldType fieldType()

Overrides:

fieldType in class FieldMapper

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

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

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

doXContentBody

protected void doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 boolean includeDefaults,
 org.opensearch.core.xcontent.ToXContent.Params params)
                       throws IOException

Overrides:

doXContentBody in class ParametrizedFieldMapper

Throws:

IOException

getType

public String getType()

getScript

public Script getScript()