org.elasticsearch.common.geo.builders

Enum ShapeBuilder.GeoShapeType

java.lang.Object

java.lang.Enum<ShapeBuilder.GeoShapeType>

org.elasticsearch.common.geo.builders.ShapeBuilder.GeoShapeType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ShapeBuilder.GeoShapeType>

Enclosing class:

ShapeBuilder

public static enum ShapeBuilder.GeoShapeType
extends java.lang.Enum<ShapeBuilder.GeoShapeType>

Enumeration that lists all ShapeBuilder.GeoShapeTypes that can be handled

Enum Constant Summary

Enum Constants

Enum Constant and Description
CIRCLE
ENVELOPE
GEOMETRYCOLLECTION
LINESTRING
MULTILINESTRING
MULTIPOINT
MULTIPOLYGON
POINT
POLYGON

Method Summary

Modifier and Type	Method and Description
static ShapeBuilder.GeoShapeType	forName(java.lang.String geoshapename)
static ShapeBuilder	parse(XContentParser parser)
static ShapeBuilder	parse(XContentParser parser, GeoShapeFieldMapper shapeMapper) Parse the geometry specified by the source document and return a ShapeBuilder instance used to build the actual geometry
protected static CircleBuilder	parseCircle(ShapeBuilder.CoordinateNode coordinates, DistanceUnit.Distance radius)
protected static EnvelopeBuilder	parseEnvelope(ShapeBuilder.CoordinateNode coordinates)
protected static GeometryCollectionBuilder	parseGeometries(XContentParser parser, GeoShapeFieldMapper mapper) Parse the geometries array of a GeometryCollection
protected static LineStringBuilder	parseLinearRing(ShapeBuilder.CoordinateNode coordinates, boolean coerce)
protected static LineStringBuilder	parseLineString(ShapeBuilder.CoordinateNode coordinates)
protected static MultiLineStringBuilder	parseMultiLine(ShapeBuilder.CoordinateNode coordinates)
protected static MultiPointBuilder	parseMultiPoint(ShapeBuilder.CoordinateNode coordinates)
protected static MultiPolygonBuilder	parseMultiPolygon(ShapeBuilder.CoordinateNode coordinates, ShapeBuilder.Orientation orientation, boolean coerce)
protected static PointBuilder	parsePoint(ShapeBuilder.CoordinateNode node)
protected static PolygonBuilder	parsePolygon(ShapeBuilder.CoordinateNode coordinates, ShapeBuilder.Orientation orientation, boolean coerce)
protected java.lang.String	shapeName()
protected static void	validateMultiPointNode(ShapeBuilder.CoordinateNode coordinates)
protected static void	validatePointNode(ShapeBuilder.CoordinateNode node)
static ShapeBuilder.GeoShapeType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ShapeBuilder.GeoShapeType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POINT

public static final ShapeBuilder.GeoShapeType POINT

MULTIPOINT

public static final ShapeBuilder.GeoShapeType MULTIPOINT

LINESTRING

public static final ShapeBuilder.GeoShapeType LINESTRING

MULTILINESTRING

public static final ShapeBuilder.GeoShapeType MULTILINESTRING

POLYGON

public static final ShapeBuilder.GeoShapeType POLYGON

MULTIPOLYGON

public static final ShapeBuilder.GeoShapeType MULTIPOLYGON

GEOMETRYCOLLECTION

public static final ShapeBuilder.GeoShapeType GEOMETRYCOLLECTION

ENVELOPE

public static final ShapeBuilder.GeoShapeType ENVELOPE

CIRCLE

public static final ShapeBuilder.GeoShapeType CIRCLE

Method Detail

values

public static ShapeBuilder.GeoShapeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ShapeBuilder.GeoShapeType c : ShapeBuilder.GeoShapeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ShapeBuilder.GeoShapeType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

shapeName

protected java.lang.String shapeName()

forName

public static ShapeBuilder.GeoShapeType forName(java.lang.String geoshapename)

parse

public static ShapeBuilder parse(XContentParser parser)
                          throws java.io.IOException

Throws:

java.io.IOException

parse

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

Parse the geometry specified by the source document and return a ShapeBuilder instance used to build the actual geometry

Parameters:

parser - - parse utility object including source document

shapeMapper - - field mapper needed for index specific parameters

Returns:

ShapeBuilder - a builder instance used to create the geometry

Throws:

java.io.IOException

validatePointNode

protected static void validatePointNode(ShapeBuilder.CoordinateNode node)

parsePoint

protected static PointBuilder parsePoint(ShapeBuilder.CoordinateNode node)

parseCircle

protected static CircleBuilder parseCircle(ShapeBuilder.CoordinateNode coordinates,
                                           DistanceUnit.Distance radius)

parseEnvelope

protected static EnvelopeBuilder parseEnvelope(ShapeBuilder.CoordinateNode coordinates)

validateMultiPointNode

protected static void validateMultiPointNode(ShapeBuilder.CoordinateNode coordinates)

parseMultiPoint

protected static MultiPointBuilder parseMultiPoint(ShapeBuilder.CoordinateNode coordinates)

parseLineString

protected static LineStringBuilder parseLineString(ShapeBuilder.CoordinateNode coordinates)

parseMultiLine

protected static MultiLineStringBuilder parseMultiLine(ShapeBuilder.CoordinateNode coordinates)

parseLinearRing

protected static LineStringBuilder parseLinearRing(ShapeBuilder.CoordinateNode coordinates,
                                                   boolean coerce)

parsePolygon

protected static PolygonBuilder parsePolygon(ShapeBuilder.CoordinateNode coordinates,
                                             ShapeBuilder.Orientation orientation,
                                             boolean coerce)

parseMultiPolygon

protected static MultiPolygonBuilder parseMultiPolygon(ShapeBuilder.CoordinateNode coordinates,
                                                       ShapeBuilder.Orientation orientation,
                                                       boolean coerce)

parseGeometries

protected static GeometryCollectionBuilder parseGeometries(XContentParser parser,
                                                           GeoShapeFieldMapper mapper)
                                                    throws java.io.IOException

Parse the geometries array of a GeometryCollection

Parameters:

parser - Parser that will be read from

Returns:

Geometry[] geometries of the GeometryCollection

Throws:

java.io.IOException - Thrown if an error occurs while reading from the XContentParser