Package org.elasticsearch.common.geo.parsers

Interface ShapeParser

public interface ShapeParser

first point of entry for a shape parser

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FIELD_COORDINATES
static ParseField	FIELD_GEOMETRIES
static ParseField	FIELD_ORIENTATION
static ParseField	FIELD_TYPE

Method Summary

Static Methods

Modifier and Type	Method	Description
static ShapeBuilder	parse(XContentParser parser)	Create a new ShapeBuilder from XContent
static ShapeBuilder	parse(XContentParser parser, GeoShapeFieldMapper shapeMapper)	Create a new ShapeBuilder from XContent

Field Detail

FIELD_TYPE

static final ParseField FIELD_TYPE

FIELD_COORDINATES

static final ParseField FIELD_COORDINATES

FIELD_GEOMETRIES

static final ParseField FIELD_GEOMETRIES

FIELD_ORIENTATION

static final ParseField FIELD_ORIENTATION

Method Detail

parse

static ShapeBuilder parse(XContentParser parser,
                          GeoShapeFieldMapper shapeMapper)
                   throws java.io.IOException

Create a new ShapeBuilder from XContent

Parameters:

parser - parser to read the GeoShape from

shapeMapper - 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:

java.io.IOException - if the input could not be read

parse

static ShapeBuilder parse(XContentParser parser)
                   throws java.io.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:

java.io.IOException - if the input could not be read