Package org.opensearch.index.mapper

Class FlatObjectFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.DynamicKeyFieldMapper

org.opensearch.index.mapper.FlatObjectFieldMapper

All Implemented Interfaces:

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

public final class FlatObjectFieldMapper
extends DynamicKeyFieldMapper

A field mapper for flat_objects. This mapper accepts JSON object and treat as string fields in one index.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlatObjectFieldMapper.Builder	The builder for the flat_object field mapper using default parameters
static class	FlatObjectFieldMapper.Defaults	In flat_object field mapper, field type is similar to keyword field type Cannot be tokenized, can OmitNorms, and can setIndexOption.
static class	FlatObjectFieldMapper.FlatObjectField	FlatObjectFieldType is the parent field type.
static final class	FlatObjectFieldMapper.FlatObjectFieldType	flat_object fields type contains its own fieldType, one valueFieldType and one valueAndPathFieldType
static class	FlatObjectFieldMapper.TypeParser	Creates a new TypeParser for flatObjectFieldMapper that does not use ParameterizedFieldMapper

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
static final FlatObjectFieldMapper.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

Method Summary

Modifier and Type	Method	Description
protected FlatObjectFieldMapper	clone()
protected String	contentType()
FlatObjectFieldMapper.FlatObjectFieldType	fieldType()
Iterator<Mapper>	iterator()
MappedFieldType	keyedFieldType(String key)
protected void	mergeOptions(FieldMapper other, List<String> conflicts)	Merge type-specific options and check for incompatible settings in mappings to be merged
protected void	parseCreateField(ParseContext context)	Parse the field value and populate the fields on ParseContext.doc().

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

copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, doXContentBody, indexedByDefault, indexOptionToString, merge, 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

PARSER

public static final FlatObjectFieldMapper.TypeParser PARSER

Method Details

keyedFieldType

public MappedFieldType keyedFieldType(String key)

Specified by:

keyedFieldType in class DynamicKeyFieldMapper

clone

protected FlatObjectFieldMapper clone()

Overrides:

clone in class FieldMapper

mergeOptions

protected void mergeOptions(FieldMapper other,
 List<String> conflicts)

Description copied from class: FieldMapper

Merge type-specific options and check for incompatible settings in mappings to be merged

Specified by:

mergeOptions in class FieldMapper

fieldType

public FlatObjectFieldMapper.FlatObjectFieldType 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

iterator

public Iterator<Mapper> iterator()

Specified by:

iterator in interface Iterable<Mapper>

Overrides:

iterator in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper