com.datastax.dse.driver.api.core.data.geometry

Interface Polygon

All Superinterfaces:

Geometry

public interface Polygon
extends Geometry

The driver-side representation of DSE's Polygon.

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

The default implementation returned by the driver is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Polygon.Builder Provides a simple DSL to build a polygon.

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	fromPoints(Point p1, Point p2, Point p3, Point... pn) Creates a polygon from a series of 3 or more points.
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 interface com.datastax.dse.driver.api.core.data.geometry.Geometry

asGeoJson, asWellKnownBinary, asWellKnownText, contains

Method Detail

fromWellKnownText

@NonNull
static Polygon fromWellKnownText(@NonNull
                                          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:

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

fromWellKnownBinary

@NonNull
static Polygon fromWellKnownBinary(@NonNull
                                            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:

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

fromGeoJson

@NonNull
static Polygon fromGeoJson(@NonNull
                                    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:

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

fromPoints

@NonNull
static Polygon fromPoints(@NonNull
                                   Point p1,
                                   @NonNull
                                   Point p2,
                                   @NonNull
                                   Point p3,
                                   @NonNull
                                   Point... pn)

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

builder

@NonNull
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 cases, consider fromPoints(Point, Point, Point, Point...) instead.

getExteriorRing

@NonNull
List<Point> getExteriorRing()

Returns the external ring of the polygon.

getInteriorRings

@NonNull
List<List<Point>> getInteriorRings()

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