Package org.opensearch.join.mapper

Class MetaJoinFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.join.mapper.MetaJoinFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class MetaJoinFieldMapper
extends FieldMapper

Simple field mapper hack to ensure that there is a one and only ParentJoinFieldMapper per mapping. This field mapper is not used to index or query any data, it is used as a marker in the mapping that denotes the presence of a parent-join field and forbids the addition of any additional ones. This class is also used to quickly retrieve the parent-join field defined in a mapping without specifying the name of the field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetaJoinFieldMapper.MetaJoinFieldType

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, Mapper.TypeParser

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected MetaJoinFieldMapper	clone()
protected String	contentType()
MetaJoinFieldMapper.MetaJoinFieldType	fieldType()
protected void	mergeOptions(FieldMapper other, List<String> conflicts)
protected void	parseCreateField(ParseContext context)

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

copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, doXContentBody, indexedByDefault, indexOptionToString, iterator, 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.common.xcontent.ToXContentFragment

isFragment

Method Details

fieldType

public MetaJoinFieldMapper.MetaJoinFieldType fieldType()

Overrides:

fieldType in class FieldMapper

clone

protected MetaJoinFieldMapper clone()

Overrides:

clone in class FieldMapper

mergeOptions

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

Specified by:

mergeOptions in class FieldMapper

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws IOException

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper