Package org.elasticsearch.common.geo

Enum GeoShapeType

java.lang.Object

java.lang.Enum<GeoShapeType>

org.elasticsearch.common.geo.GeoShapeType

All Implemented Interfaces:

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

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

Enumeration that lists all GeoShapeTypes that can be parsed and indexed

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static GeoShapeType	forName(java.lang.String geoshapename)
abstract ShapeBuilder	getBuilder(CoordinateNode coordinates, DistanceUnit.Distance radius, ShapeBuilder.Orientation orientation, boolean coerce)
static java.util.List<NamedWriteableRegistry.Entry>	getShapeWriteables()
java.lang.String	shapeName()
java.lang.String	toString()
static GeoShapeType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static GeoShapeType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
java.lang.String	wktName()	wkt shape name

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POINT

public static final GeoShapeType POINT

MULTIPOINT

public static final GeoShapeType MULTIPOINT

LINESTRING

public static final GeoShapeType LINESTRING

MULTILINESTRING

public static final GeoShapeType MULTILINESTRING

POLYGON

public static final GeoShapeType POLYGON

MULTIPOLYGON

public static final GeoShapeType MULTIPOLYGON

ENVELOPE

public static final GeoShapeType ENVELOPE

CIRCLE

public static final GeoShapeType CIRCLE

GEOMETRYCOLLECTION

public static final GeoShapeType GEOMETRYCOLLECTION

Method Detail

values

public static 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 (GeoShapeType c : 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 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

public java.lang.String shapeName()

forName

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

getBuilder

public abstract ShapeBuilder getBuilder(CoordinateNode coordinates,
                                        DistanceUnit.Distance radius,
                                        ShapeBuilder.Orientation orientation,
                                        boolean coerce)

wktName

public java.lang.String wktName()

wkt shape name

getShapeWriteables

public static java.util.List<NamedWriteableRegistry.Entry> getShapeWriteables()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<GeoShapeType>