Package org.elasticsearch.join.mapper

Class ParentIdFieldMapper

  • 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 ParentIdFieldMapper
extends org.elasticsearch.index.mapper.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 class  ParentIdFieldMapper.ParentIdFieldType  

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

        org.elasticsearch.index.mapper.FieldMapper.CopyTo, org.elasticsearch.index.mapper.FieldMapper.MultiFields

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

        org.elasticsearch.index.mapper.Mapper.BuilderContext, org.elasticsearch.index.mapper.Mapper.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 inherited from class org.elasticsearch.index.mapper.FieldMapper

        COERCE_SETTING, copyTo, defaultFieldType, fieldType, IGNORE_MALFORMED_SETTING, indexCreatedVersion, multiFields

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

        EMPTY_PARAMS

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ParentIdFieldMapper​(java.lang.String simpleName, java.lang.String parentName, java.util.Set<java.lang.String> children, org.elasticsearch.index.mapper.MappedFieldType fieldType, org.elasticsearch.common.settings.Settings indexSettings)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected ParentIdFieldMapper clone()  
      protected java.lang.String contentType()  
      protected void doMerge​(org.elasticsearch.index.mapper.Mapper mergeWith, boolean updateAllTypes)  
      org.apache.lucene.search.Query getChildFilter​(java.lang.String type)  
      java.util.Collection<java.lang.String> getChildren()
      Returns the children names associated with this mapper.
      org.apache.lucene.search.Query getChildrenFilter()  
      org.apache.lucene.search.Query getParentFilter()  
      java.lang.String getParentName()
      Returns the parent name associated with this mapper.
      protected void parseCreateField​(org.elasticsearch.index.mapper.ParseContext context, java.util.List<org.apache.lucene.index.IndexableField> fields)  

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

        copyTo, createFieldNamesField, doXContentAnalyzers, doXContentBody, doXContentDocValues, fieldType, indexOptionToString, iterator, merge, name, parse, termVectorOptionsToString, toXContent, typeName, updateFieldType

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

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

        simpleName

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

        isFragment

    • Constructor Detail

      • ParentIdFieldMapper

        protected ParentIdFieldMapper​(java.lang.String simpleName,
                              java.lang.String parentName,
                              java.util.Set<java.lang.String> children,
                              org.elasticsearch.index.mapper.MappedFieldType fieldType,
                              org.elasticsearch.common.settings.Settings indexSettings)

    • Method Detail

      • clone

        protected ParentIdFieldMapper clone()
        Overrides:
        clone in class org.elasticsearch.index.mapper.FieldMapper

      • getParentName

        public java.lang.String getParentName()
        Returns the parent name associated with this mapper.

      • getParentFilter

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

      • getChildren

        public java.util.Collection<java.lang.String> getChildren()
        Returns the children names associated with this mapper.

      • getChildFilter

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

      • getChildrenFilter

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

      • parseCreateField

        protected void parseCreateField​(org.elasticsearch.index.mapper.ParseContext context,
                                java.util.List<org.apache.lucene.index.IndexableField> fields)
                         throws java.io.IOException
        Specified by:
        parseCreateField in class org.elasticsearch.index.mapper.FieldMapper
        Throws:
        java.io.IOException

      • doMerge

        protected void doMerge​(org.elasticsearch.index.mapper.Mapper mergeWith,
                       boolean updateAllTypes)
        Overrides:
        doMerge in class org.elasticsearch.index.mapper.FieldMapper

      • contentType

        protected java.lang.String contentType()
        Specified by:
        contentType in class org.elasticsearch.index.mapper.FieldMapper