com.datastax.driver.dse.geometry

Class Polygon

java.lang.Object

com.datastax.driver.dse.geometry.Geometry

com.datastax.driver.dse.geometry.Polygon

All Implemented Interfaces:

Serializable

public class Polygon
extends Geometry

The driver-side representation of DSE's PolygonType.

This is a planar surface in a two-dimensional XY-plane, represented by one exterior boundary and 0 or more interior boundaries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Polygon.Builder Provides a DSL to build a polygon.

Constructor Summary

Constructors

Constructor and Description
Polygon(Point p1, Point p2, Point p3, Point... pn) Creates a polygon instance from a series of 3 or more points.

Method Summary

Modifier and Type	Method and Description
static Polygon.Builder	builder() Returns a polygon builder.
static Polygon	fromGeoJson(String source) Creates a polygon from a GeoJSON Polygon representation.
static Polygon	fromWellKnownBinary(ByteBuffer source) Creates a polygon from its Well-known Binary (WKB) representation.
static Polygon	fromWellKnownText(String source) Creates a polygon from its Well-known Text (WKT) representation.
List<Point>	getExteriorRing() Returns the external ring of the polygon.
List<List<Point>>	getInteriorRings() Returns the internal rings of the polygon, i.e.

Methods inherited from class com.datastax.driver.dse.geometry.Geometry

asGeoJson, asWellKnownBinary, asWellKnownText, contains, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Polygon

public Polygon(Point p1,
               Point p2,
               Point p3,
               Point... pn)

Creates a polygon instance from a series of 3 or more points.

Parameters:

p1 - the first point.

p2 - the second point.

p3 - the third point.

pn - additional points.

Method Detail

fromWellKnownText

public static Polygon fromWellKnownText(String source)

Creates a polygon from its Well-known Text (WKT) representation.

Parameters:

source - the Well-known Text representation to parse.

Returns:

the polygon represented by the WKT.

Throws:

InvalidTypeException - if the string does not contain a valid Well-known Text representation.

fromWellKnownBinary

public static Polygon fromWellKnownBinary(ByteBuffer source)

Creates a polygon from its Well-known Binary (WKB) representation.

Parameters:

source - the Well-known Binary representation to parse.

Returns:

the polygon represented by the WKB.

Throws:

InvalidTypeException - if the provided ByteBuffer does not contain a valid Well-known Binary representation.

fromGeoJson

public static Polygon fromGeoJson(String source)

Creates a polygon from a GeoJSON Polygon representation.

Parameters:

source - the GeoJSON Polygon representation to parse.

Returns:

the polygon represented by the GeoJSON Polygon.

Throws:

InvalidTypeException - if the string does not contain a valid GeoJSON Polygon representation.

getExteriorRing

public List<Point> getExteriorRing()

Returns the external ring of the polygon.

Returns:

the external ring (as an immutable list).

getInteriorRings

public List<List<Point>> getInteriorRings()

Returns the internal rings of the polygon, i.e. any holes inside of it (or islands inside of the holes).

Returns:

the internal rings (as an immutable list of immutable lists).

builder

public static Polygon.Builder builder()

Returns a polygon builder.

This is intended for complex polygons with multiple rings (i.e. holes inside the polygon). For simple case, consider the class's constructors.

Returns:

the builder.