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:
java.lang.Cloneable, java.lang.Iterable<org.elasticsearch.index.mapper.Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.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 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 java.lang.Object>, org.elasticsearch.index.mapper.FieldMapper.MultiFields, org.elasticsearch.index.mapper.FieldMapper.Parameter<T extends java.lang.Object>, org.elasticsearch.index.mapper.FieldMapper.Serializer<T extends java.lang.Object>, org.elasticsearch.index.mapper.FieldMapper.SerializerCheck<T extends java.lang.Object>, org.elasticsearch.index.mapper.FieldMapper.TypeParser

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

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

  • Field Summary

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

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

    COERCE_SETTING, copyTo, IGNORE_MALFORMED_SETTING, indexAnalyzers, mappedFieldType, multiFields

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    protected java.lang.String contentType()  
    protected void doValidate​(org.elasticsearch.index.mapper.MappingLookup mappers)  
    protected void doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    ParentJoinFieldMapper.JoinFieldType fieldType()  
    org.elasticsearch.index.mapper.FieldMapper.Builder getMergeBuilder()  
    java.util.Iterator<org.elasticsearch.index.mapper.Mapper> iterator()  
    void parse​(org.elasticsearch.index.mapper.ParseContext context)  
    protected void parseCreateField​(org.elasticsearch.index.mapper.ParseContext context)  

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

    checkIncomingMergeType, copyTo, createFieldNamesField, indexAnalyzers, merge, multiFields, name, 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.common.xcontent.ToXContentFragment

    isFragment

  • Field Details

    • NAME

      public static final java.lang.String NAME
      See Also:
      Constant Field Values

    • CONTENT_TYPE

      public static final java.lang.String CONTENT_TYPE
      See Also:
      Constant Field Values

    • PARSER

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

  • Constructor Details

    • ParentJoinFieldMapper

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

  • Method Details

    • contentType

      protected java.lang.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 java.util.Iterator<org.elasticsearch.index.mapper.Mapper> iterator()
      Specified by:
      iterator in interface java.lang.Iterable<org.elasticsearch.index.mapper.Mapper>
      Overrides:
      iterator in class org.elasticsearch.index.mapper.FieldMapper

    • parseCreateField

      protected void parseCreateField​(org.elasticsearch.index.mapper.ParseContext context)
      Specified by:
      parseCreateField in class org.elasticsearch.index.mapper.FieldMapper

    • parse

      public void parse​(org.elasticsearch.index.mapper.ParseContext context) throws java.io.IOException
      Overrides:
      parse in class org.elasticsearch.index.mapper.FieldMapper
      Throws:
      java.io.IOException

    • doXContentBody

      protected void doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Overrides:
      doXContentBody in class org.elasticsearch.index.mapper.FieldMapper
      Throws:
      java.io.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 mappers)
      Overrides:
      doValidate in class org.elasticsearch.index.mapper.FieldMapper