Module org.elasticsearch.server

Package org.elasticsearch.common.geo

Class GenericPointParser<T>

java.lang.Object

org.elasticsearch.common.geo.GenericPointParser<T>

Type Parameters:

T - type of point to produce (either geographic or cartesian)

public abstract class GenericPointParser<T>
extends Object

This class can parse points from XContentParser and supports several formats:

Constructor Summary

Constructors

Constructor	Description
GenericPointParser(String mapType, String xField, String yField, boolean supportGeohash)	Construct the parser with some configuration settings

Method Summary

Modifier and Type	Method	Description
abstract void	assertZValue(boolean ignoreZValue, double zValue)
abstract T	createPoint(double xValue, double yValue)
abstract String	fieldError()
T	parsePoint(XContentParser parser, boolean ignoreZValue, Function<String,T> fromString, Function<String,T> fromGeohash)	Parse a Point with an XContentParser.

Methods inherited from class java.lang.Object

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

Constructor Details

GenericPointParser

public GenericPointParser(String mapType,
 String xField,
 String yField,
 boolean supportGeohash)

Construct the parser with some configuration settings

Parameters:

mapType - whether the parser is for 'geo_point' or 'point'

xField - the name of the first coordinate when constructing points (either 'x' or 'lat')

yField - the name of the second coordinate when constructing points (either 'y' or 'lon')

supportGeohash - whether to support parsing geohash values (only geo_point supports this currently)

Method Details

assertZValue

public abstract void assertZValue(boolean ignoreZValue,
 double zValue)

createPoint

public abstract T createPoint(double xValue,
 double yValue)

fieldError

public abstract String fieldError()

parsePoint

public T parsePoint(XContentParser parser,
 boolean ignoreZValue,
 Function<String,T> fromString,
 Function<String,T> fromGeohash)
             throws IOException,
ElasticsearchParseException

Parse a Point with an XContentParser.

Parameters:

parser - XContentParser to parse the value from

ignoreZValue - XContentParser to not throw an error if 3 dimensional data is provided

Returns:

new Point parsed from the parser

Throws:

IOException

ElasticsearchParseException