Package org.elasticsearch.index.mapper

Class ObjectMapper

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

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ObjectMapper.Builder<T extends ObjectMapper.Builder,​Y extends ObjectMapper>  
    static class  ObjectMapper.Defaults  
    static class  ObjectMapper.Dynamic  
    static class  ObjectMapper.Nested  
    static class  ObjectMapper.TypeParser  

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

    Mapper.BuilderContext

    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 NESTED_CONTENT_TYPE  

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    protected ObjectMapper clone()  
    protected void doMerge​(ObjectMapper mergeWith)  
    protected void doXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    ObjectMapper.Dynamic dynamic()  
    java.lang.String fullPath()  
    Mapper getMapper​(java.lang.String field)  
    ObjectMapper getParentObjectMapper​(MapperService mapperService)
    Returns the parent ObjectMapper instance of the specified object mapper or null if there isn't any.
    boolean isEnabled()  
    java.util.Iterator<Mapper> iterator()  
    ObjectMapper mappingUpdate​(Mapper mapper)
    Build a mapping update with the provided sub mapping update.
    ObjectMapper merge​(Mapper mergeWith)
    Return the merge of mergeWith into this.
    java.lang.String name()
    Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
    ObjectMapper.Nested nested()  
    org.apache.lucene.search.Query nestedTypeFilter()  
    java.lang.String nestedTypePathAsString()  
    boolean parentObjectMapperAreNested​(MapperService mapperService)
    Returns whether all parent objects fields are nested too.
    protected void putMapper​(Mapper mapper)  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params, org.elasticsearch.common.xcontent.ToXContent custom)  
    java.lang.String typeName()
    Returns a name representing the type of this mapper.
    ObjectMapper updateFieldType​(java.util.Map<java.lang.String,​MappedFieldType> fullNameToFieldType)
    Update the field type of this mapper.

    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 java.lang.Iterable

    forEach, spliterator

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

    isFragment

  • Field Details

  • Method Details

    • clone

      protected ObjectMapper clone()
      Overrides:
      clone in class java.lang.Object

    • mappingUpdate

      public ObjectMapper mappingUpdate​(Mapper mapper)
      Build a mapping update with the provided sub mapping update.

    • name

      public java.lang.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 java.lang.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()

    • getMapper

      public Mapper getMapper​(java.lang.String field)

    • nested

      public ObjectMapper.Nested nested()

    • nestedTypeFilter

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

    • putMapper

      protected void putMapper​(Mapper mapper)

    • iterator

      public java.util.Iterator<Mapper> iterator()
      Specified by:
      iterator in interface java.lang.Iterable<Mapper>

    • fullPath

      public java.lang.String fullPath()

    • nestedTypePathAsString

      public java.lang.String nestedTypePathAsString()

    • dynamic

      public final ObjectMapper.Dynamic dynamic()

    • getParentObjectMapper

      public ObjectMapper getParentObjectMapper​(MapperService mapperService)
      Returns the parent ObjectMapper instance of the specified object mapper or null if there isn't any.

    • parentObjectMapperAreNested

      public boolean parentObjectMapperAreNested​(MapperService mapperService)
      Returns whether all parent objects fields are nested too.

    • 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

    • doMerge

      protected void doMerge​(ObjectMapper mergeWith)

    • updateFieldType

      public ObjectMapper updateFieldType​(java.util.Map<java.lang.String,​MappedFieldType> fullNameToFieldType)
      Description copied from class: Mapper
      Update the field type of this mapper. This is necessary because some mapping updates can modify mappings across several types. This method must return a copy of the mapper so that the current mapper is not modified.
      Specified by:
      updateFieldType in class Mapper

    • toXContent

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

    • toXContent

      public void toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params, org.elasticsearch.common.xcontent.ToXContent custom) throws java.io.IOException
      Throws:
      java.io.IOException

    • doXContent

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