Package org.elasticsearch.index.mapper

Class ObjectMapper

java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.ObjectMapper
All Implemented Interfaces:
Cloneable, Iterable<Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Direct Known Subclasses:
NestedObjectMapper, RootObjectMapper
public class ObjectMapper extends Mapper implements Cloneable

  • Field Details

  • Method Details

    • clone

      protected ObjectMapper clone()
      Overrides:
      clone in class Object

    • name

      public String name()
      Description copied from class: Mapper
      Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
      Specified by:
      name in class Mapper

    • typeName

      public String typeName()
      Description copied from class: Mapper
      Returns a name representing the type of this mapper.
      Specified by:
      typeName in class Mapper

    • isEnabled

      public boolean isEnabled()

    • isNested

      public boolean isNested()

    • getMapper

      public Mapper getMapper​(String field)

    • putMapper

      protected void putMapper​(Mapper mapper)

    • iterator

      public Iterator<Mapper> iterator()
      Specified by:
      iterator in interface Iterable<Mapper>

    • fullPath

      public String fullPath()

    • dynamic

      public final ObjectMapper.Dynamic dynamic()

    • merge

      public ObjectMapper merge​(Mapper mergeWith)
      Description copied from class: Mapper
      Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.
      Specified by:
      merge in class Mapper

    • validate

      public void validate​(MappingLookup mappers)
      Description copied from class: Mapper
      Validate any cross-field references made by this mapper
      Specified by:
      validate in class Mapper
      Parameters:
      mappers - a MappingLookup that can produce references to other mappers

    • merge

      public ObjectMapper merge​(Mapper mergeWith, MapperService.MergeReason reason)

    • doMerge

      protected void doMerge​(ObjectMapper mergeWith, MapperService.MergeReason reason)

    • 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

    • serializeMappers

      protected void serializeMappers​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Throws:
      IOException

    • doXContent

      protected void doXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Throws:
      IOException