Package org.elasticsearch.common.geo.parsers

Interface ShapeParser

public interface ShapeParser
first point of entry for a shape parser

  • Field Details

    • FIELD_TYPE

      static final org.elasticsearch.common.xcontent.ParseField FIELD_TYPE

    • FIELD_COORDINATES

      static final org.elasticsearch.common.xcontent.ParseField FIELD_COORDINATES

    • FIELD_GEOMETRIES

      static final org.elasticsearch.common.xcontent.ParseField FIELD_GEOMETRIES

    • FIELD_ORIENTATION

      static final org.elasticsearch.common.xcontent.ParseField FIELD_ORIENTATION

  • Method Details

    • parse

      static ShapeBuilder<?,​?,​?> parse​(org.elasticsearch.common.xcontent.XContentParser parser, AbstractGeometryFieldMapper<?> geometryMapper) throws IOException
      Create a new ShapeBuilder from XContent
      Parameters:
      parser - parser to read the GeoShape from
      geometryMapper - document field mapper reference required for spatial parameters relevant to the shape construction process (e.g., orientation) todo: refactor to place build specific parameters in the SpatialContext
      Returns:
      ShapeBuilder read from the parser or null if the parsers current token has been null
      Throws:
      IOException - if the input could not be read

    • parse

      static ShapeBuilder<?,​?,​?> parse​(org.elasticsearch.common.xcontent.XContentParser parser) throws IOException
      Create a new ShapeBuilder from XContent
      Parameters:
      parser - parser to read the GeoShape from
      Returns:
      ShapeBuilder read from the parser or null if the parsers current token has been null
      Throws:
      IOException - if the input could not be read

    • parse

      static ShapeBuilder<?,​?,​?> parse​(Object value) throws IOException
      Throws:
      IOException