Package org.elasticsearch.index.mapper

Class AbstractGeometryFieldMapper.Parser<Parsed>

java.lang.Object
org.elasticsearch.index.mapper.AbstractGeometryFieldMapper.Parser<Parsed>
Direct Known Subclasses:
AbstractPointGeometryFieldMapper.PointParser, GeoShapeParser
Enclosing class:
AbstractGeometryFieldMapper<Parsed,​Processed>
public abstract static class AbstractGeometryFieldMapper.Parser<Parsed>
extends java.lang.Object
Interface representing parser in geometry indexing pipeline.

  • Constructor Summary

    Constructors 
    Constructor Description
    Parser()  

  • Method Summary

    Modifier and Type Method Description
    abstract java.lang.Object format​(Parsed value, java.lang.String format)
    Given a parsed value and a format string, formats the value into a plain Java object.
    abstract Parsed parse​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parse the given xContent value to an object of type AbstractGeometryFieldMapper.Parser.
    java.lang.Object parseAndFormatObject​(java.lang.Object value, java.lang.String format)
    Parses the given value, then formats it according to the 'format' string.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • parse

      public abstract Parsed parse​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException, java.text.ParseException
      Parse the given xContent value to an object of type AbstractGeometryFieldMapper.Parser. The value can be in any supported format.
      Throws:
      java.io.IOException
      java.text.ParseException

    • format

      public abstract java.lang.Object format​(Parsed value, java.lang.String format)
      Given a parsed value and a format string, formats the value into a plain Java object. Supported formats include 'geojson' and 'wkt'. The different formats are defined as subclasses of GeometryFormat.

    • parseAndFormatObject

      public java.lang.Object parseAndFormatObject​(java.lang.Object value, java.lang.String format)
      Parses the given value, then formats it according to the 'format' string. By default, this method simply parses the value using parse(org.elasticsearch.common.xcontent.XContentParser), then formats it with format(Parsed, java.lang.String). However some AbstractGeometryFieldMapper.Parser implementations override this as they can avoid parsing the value if it is already in the right format.