Class ParentIdFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.join.mapper.ParentIdFieldMapper

All Implemented Interfaces:

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

public final class ParentIdFieldMapper
extends FieldMapper

A field mapper used internally by the ParentJoinFieldMapper to index the value that link documents in the index (parent _id or _id if the document is a parent).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParentIdFieldMapper.ParentIdFieldType

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.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, derivedFieldGenerator, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParentIdFieldMapper(String simpleName, String parentName, Set<String> children, org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType)

Method Summary

Modifier and Type	Method	Description
protected ParentIdFieldMapper	clone()
protected String	contentType()
org.apache.lucene.search.Query	getChildFilter(String type)
Collection<String>	getChildren()	Returns the children names associated with this mapper.
org.apache.lucene.search.Query	getChildrenFilter()
org.apache.lucene.search.Query	getParentFilter()
String	getParentName()	Returns the parent name associated with this mapper.
protected void	mergeOptions(FieldMapper other, List<String> conflicts)
protected void	parseCreateField(ParseContext context)

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

canDeriveSource, canDeriveSourceInternal, copyTo, createFieldNamesField, derivedFieldGenerator, deriveSource, docValuesByDefault, doValidate, doXContentAnalyzers, doXContentBody, fieldType, getDerivedFieldGenerator, ignoreMalformed, indexedByDefault, indexOptionToString, iterator, merge, multiFields, name, parse, parsesArrayValue, setDerivedFieldGenerator, 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

Constructor Details

ParentIdFieldMapper

protected ParentIdFieldMapper(String simpleName,
 String parentName,
 Set<String> children,
 org.apache.lucene.document.FieldType fieldType,
 MappedFieldType mappedFieldType)

Method Details

clone

protected ParentIdFieldMapper clone()

Overrides:

clone in class FieldMapper

getParentName

public String getParentName()

Returns the parent name associated with this mapper.

getParentFilter

public org.apache.lucene.search.Query getParentFilter()

getChildren

public Collection<String> getChildren()

Returns the children names associated with this mapper.

getChildFilter

public org.apache.lucene.search.Query getChildFilter(String type)

getChildrenFilter

public org.apache.lucene.search.Query getChildrenFilter()

parseCreateField

protected void parseCreateField(ParseContext context)
                         throws IOException

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

mergeOptions

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

Specified by:

mergeOptions in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper