Package org.elasticsearch.join.mapper

Class ParentJoinFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.join.mapper.ParentJoinFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<org.elasticsearch.index.mapper.Mapper>, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

public final class ParentJoinFieldMapper
extends org.elasticsearch.index.mapper.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParentJoinFieldMapper.Builder
static class	ParentJoinFieldMapper.Defaults
static final class	ParentJoinFieldMapper.JoinFieldType

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.FieldMapper.Conflicts, org.elasticsearch.index.mapper.FieldMapper.CopyTo, org.elasticsearch.index.mapper.FieldMapper.MergeValidator<T extends Object>, org.elasticsearch.index.mapper.FieldMapper.MultiFields, org.elasticsearch.index.mapper.FieldMapper.Parameter<T extends Object>, org.elasticsearch.index.mapper.FieldMapper.Serializer<T extends Object>, org.elasticsearch.index.mapper.FieldMapper.SerializerCheck<T extends Object>, org.elasticsearch.index.mapper.FieldMapper.TypeParser

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	NAME
static org.elasticsearch.index.mapper.FieldMapper.TypeParser	PARSER

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper

COERCE_SETTING, copyTo, hasScript, IGNORE_MALFORMED_SETTING, indexAnalyzers, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParentJoinFieldMapper(String simpleName, org.elasticsearch.index.mapper.MappedFieldType mappedFieldType, Map<String,ParentIdFieldMapper> parentIdFields, boolean eagerGlobalOrdinals, List<org.elasticsearch.join.mapper.Relations> relations)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
protected void	doValidate(org.elasticsearch.index.mapper.MappingLookup mappingLookup)
protected void	doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
ParentJoinFieldMapper.JoinFieldType	fieldType()
org.elasticsearch.index.mapper.FieldMapper.Builder	getMergeBuilder()
Iterator<org.elasticsearch.index.mapper.Mapper>	iterator()
void	parse(org.elasticsearch.index.mapper.DocumentParserContext context)
protected void	parseCreateField(org.elasticsearch.index.mapper.DocumentParserContext context)

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

checkIncomingMergeType, copyTo, executeScript, hasScript, indexAnalyzers, indexScriptValues, merge, multiFields, name, notInMultiFields, parsesArrayValue, toXContent, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

simpleName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.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

PARSER

public static org.elasticsearch.index.mapper.FieldMapper.TypeParser PARSER

Constructor Details

ParentJoinFieldMapper

protected ParentJoinFieldMapper(String simpleName,
 org.elasticsearch.index.mapper.MappedFieldType mappedFieldType,
 Map<String,ParentIdFieldMapper> parentIdFields,
 boolean eagerGlobalOrdinals,
 List<org.elasticsearch.join.mapper.Relations> relations)

Method Details

contentType

protected String contentType()

Specified by:

contentType in class org.elasticsearch.index.mapper.FieldMapper

fieldType

public ParentJoinFieldMapper.JoinFieldType fieldType()

Overrides:

fieldType in class org.elasticsearch.index.mapper.FieldMapper

iterator

public Iterator<org.elasticsearch.index.mapper.Mapper> iterator()

Specified by:

iterator in interface Iterable<org.elasticsearch.index.mapper.Mapper>

Overrides:

iterator in class org.elasticsearch.index.mapper.FieldMapper

parseCreateField

protected void parseCreateField(org.elasticsearch.index.mapper.DocumentParserContext context)

Specified by:

parseCreateField in class org.elasticsearch.index.mapper.FieldMapper

parse

public void parse(org.elasticsearch.index.mapper.DocumentParserContext context)
           throws IOException

Overrides:

parse in class org.elasticsearch.index.mapper.FieldMapper

Throws:

IOException

doXContentBody

protected void doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                       throws IOException

Overrides:

doXContentBody in class org.elasticsearch.index.mapper.FieldMapper

Throws:

IOException

getMergeBuilder

public org.elasticsearch.index.mapper.FieldMapper.Builder getMergeBuilder()

Specified by:

getMergeBuilder in class org.elasticsearch.index.mapper.FieldMapper

doValidate

protected void doValidate(org.elasticsearch.index.mapper.MappingLookup mappingLookup)

Overrides:

doValidate in class org.elasticsearch.index.mapper.FieldMapper