Package org.elasticsearch.index.mapper

Class FieldMapper

java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Direct Known Subclasses:
AbstractGeometryFieldMapper, BinaryFieldMapper, BooleanFieldMapper, CompletionFieldMapper, DateFieldMapper, DynamicKeyFieldMapper, IpFieldMapper, KeywordFieldMapper, MetadataFieldMapper, NumberFieldMapper, RangeFieldMapper, TextFieldMapper
public abstract class FieldMapper
extends Mapper
implements java.lang.Cloneable

  • Field Details

  • Constructor Details

  • Method Details

    • 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

    • fieldType

      public MappedFieldType fieldType()

    • copyTo

      public FieldMapper.CopyTo copyTo()
      List of fields where this field should be copied to

    • parsesArrayValue

      public boolean parsesArrayValue()
      Whether this mapper can handle an array value during document parsing. If true, when an array is encountered during parsing, the document parser will pass the whole array to the mapper. If false, the array is split into individual values and each value is passed to the mapper for parsing.

    • parse

      public void parse​(ParseContext context) throws java.io.IOException
      Parse the field value using the provided ParseContext.
      Throws:
      java.io.IOException

    • parseCreateField

      protected abstract void parseCreateField​(ParseContext context, java.util.List<org.apache.lucene.index.IndexableField> fields) throws java.io.IOException
      Parse the field value and populate fields. Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token
      Throws:
      java.io.IOException

    • createFieldNamesField

      protected void createFieldNamesField​(ParseContext context, java.util.List<org.apache.lucene.index.IndexableField> fields)

    • iterator

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

    • clone

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

    • merge

      public FieldMapper 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​(Mapper mergeWith)
      Merge changes coming from mergeWith in place.

    • updateFieldType

      public FieldMapper 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

    • doXContentBody

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

    • doXContentAnalyzers

      protected final void doXContentAnalyzers​(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults) throws java.io.IOException
      Throws:
      java.io.IOException

    • doXContentDocValues

      protected void doXContentDocValues​(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults) throws java.io.IOException
      Throws:
      java.io.IOException

    • indexOptionToString

      protected static java.lang.String indexOptionToString​(org.apache.lucene.index.IndexOptions indexOption)

    • termVectorOptionsToString

      public static java.lang.String termVectorOptionsToString​(org.apache.lucene.document.FieldType fieldType)

    • contentType

      protected abstract java.lang.String contentType()