Package org.elasticsearch.index.mapper

Class Mapping

java.lang.Object
org.elasticsearch.index.mapper.Mapping
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public final class Mapping extends Object implements org.elasticsearch.common.xcontent.ToXContentFragment
Wrapper around everything that defines a mapping, without references to utility classes like MapperService, ...

  • Nested Class Summary

    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 Mapping
    EMPTY
     

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    Mapping(RootObjectMapper rootObjectMapper, MetadataFieldMapper[] metadataMappers, Map<String,Object> meta)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    getMeta()
    Returns the meta section for the current mapping
    Mapping
    merge(Mapping mergeWith, MapperService.MergeReason reason)
    Merges a new mapping into the existing one.
    CompressedXContent
    toCompressedXContent()
    Outputs this mapping instance and returns it in CompressedXContent format
    String
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    String
    type()
     

    Methods inherited from class java.lang.Object

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

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

    isFragment

  • Field Details

    • EMPTY

      public static final Mapping EMPTY

  • Constructor Details

  • Method Details

    • toCompressedXContent

      public CompressedXContent toCompressedXContent()
      Outputs this mapping instance and returns it in CompressedXContent format
      Returns:
      the CompressedXContent representation of this mapping instance

    • type

      public String type()

    • getMeta

      public Map<String,Object> getMeta()
      Returns the meta section for the current mapping

    • merge

      public Mapping merge(Mapping mergeWith, MapperService.MergeReason reason)
      Merges a new mapping into the existing one.
      Parameters:
      mergeWith - the new mapping to merge into this one.
      reason - the reason this merge was initiated.
      Returns:
      the resulting merged mapping.

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object