Package org.opensearch.join.mapper

Class ParentJoinFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.join.mapper.ParentJoinFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public final class ParentJoinFieldMapper
extends FieldMapper

A FieldMapper that creates hierarchical joins (parent-join) between documents in the same index. Only one parent-join field can be defined per index. The verification of this assumption is done through the MetaJoinFieldMapper which declares a meta field called "_parent_join". This field is only used to ensure that there is a single parent-join field defined in the mapping and cannot be used to index or query any data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParentJoinFieldMapper.Builder
static class	ParentJoinFieldMapper.Defaults
static final class	ParentJoinFieldMapper.JoinFieldType
static class	ParentJoinFieldMapper.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.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	NAME

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParentJoinFieldMapper(String simpleName, FieldType fieldType, MappedFieldType mappedFieldType, MetaJoinFieldMapper uniqueFieldMapper, List<ParentIdFieldMapper> parentIdFields, boolean eagerGlobalOrdinals)

Method Summary

Modifier and Type	Method	Description
protected ParentJoinFieldMapper	clone()
protected String	contentType()
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
ParentJoinFieldMapper.JoinFieldType	fieldType()
static ParentJoinFieldMapper	getMapper(MapperService service)	Returns the ParentJoinFieldMapper associated with the service or null if there is no parent-join field in this mapping.
ParentIdFieldMapper	getParentIdFieldMapper(String name, boolean isParent)	Returns the parent Id field mapper associated with a parent name if isParent is true and a child name otherwise.
boolean	hasChild(String name)	Returns true if name is a child name in the field.
boolean	hasParent(String name)	Returns true if name is a parent name in the field.
Iterator<Mapper>	iterator()
protected void	mergeOptions(FieldMapper other, List<String> conflicts)
void	parse(ParseContext context)
protected void	parseCreateField(ParseContext context)

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

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

ParentJoinFieldMapper

protected ParentJoinFieldMapper(String simpleName,
 FieldType fieldType,
 MappedFieldType mappedFieldType,
 MetaJoinFieldMapper uniqueFieldMapper,
 List<ParentIdFieldMapper> parentIdFields,
 boolean eagerGlobalOrdinals)

Method Details

getMapper

public static ParentJoinFieldMapper getMapper(MapperService service)

Returns the ParentJoinFieldMapper associated with the service or null if there is no parent-join field in this mapping.

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

clone

protected ParentJoinFieldMapper clone()

Overrides:

clone in class FieldMapper

fieldType

public ParentJoinFieldMapper.JoinFieldType fieldType()

Overrides:

fieldType in class FieldMapper

iterator

public Iterator<Mapper> iterator()

Specified by:

iterator in interface Iterable<Mapper>

Overrides:

iterator in class FieldMapper

hasParent

public boolean hasParent(String name)

Returns true if name is a parent name in the field.

hasChild

public boolean hasChild(String name)

Returns true if name is a child name in the field.

getParentIdFieldMapper

public ParentIdFieldMapper getParentIdFieldMapper(String name,
 boolean isParent)

Returns the parent Id field mapper associated with a parent name if isParent is true and a child name otherwise.

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

parse

public void parse(ParseContext context)
           throws IOException

Overrides:

parse in class FieldMapper

Throws:

IOException

doXContentBody

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

Overrides:

doXContentBody in class FieldMapper

Throws:

IOException