Package org.elasticsearch.index.mapper

Class Mapper

org.elasticsearch.index.mapper.Mapper
All Implemented Interfaces:
<Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Direct Known Subclasses:
FieldAliasMapper, FieldMapper, ObjectMapper
public abstract class Mapper extends implements org.elasticsearch.common.xcontent.ToXContentFragment, <Mapper>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Mapper.Builder
     
    static interface 
    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 interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
     simpleName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract Mapper
    merge​(Mapper mergeWith)
    Return the merge of mergeWith into this.
    abstract
    name()
    Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
    simpleName()
    Returns the simple name, which identifies this mapper against other mappers at the same level in the mappers hierarchy TODO: make this protected once Mapper and FieldMapper are merged together
    abstract
    typeName()
    Returns a name representing the type of this mapper.
    abstract void
    validate​(MappingLookup mappers)
    Validate any cross-field references made by this mapper

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from interface java.lang.

    , ,

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

    toXContent

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

    isFragment

  • Constructor Details

    • Mapper

      public Mapper​( simpleName)

  • Method Details

    • simpleName

      public final  simpleName()
      Returns the simple name, which identifies this mapper against other mappers at the same level in the mappers hierarchy TODO: make this protected once Mapper and FieldMapper are merged together

    • name

      public abstract  name()
      Returns the canonical name which uniquely identifies the mapper against other mappers in a type.

    • typeName

      public abstract  typeName()
      Returns a name representing the type of this mapper.

    • merge

      public abstract Mapper merge​(Mapper mergeWith)
      Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.

    • validate

      public abstract void validate​(MappingLookup mappers)
      Validate any cross-field references made by this mapper
      Parameters:
      mappers - a MappingLookup that can produce references to other mappers