org.mongodb.morphia.geo

Class Polygon

java.lang.Object

org.mongodb.morphia.geo.Polygon

All Implemented Interfaces:

Geometry

public class Polygon
extends Object
implements Geometry

This class represents either a simple polygon enclosing an area, or a more complex polygon that contains both an exterior boundary and interior boundaries (holes) within it. It will be persisted into the database according to the specification.

The factory for creating a Polygon is PolygonBuilder, which is accessible via the GeoJson.polygonBuilder method. Alternatively, simple polygons without inner rings can be created via the GeoJson.polygon factory method.

See Also:

GeoJson.polygon(LineString, LineString...), GeoJson.polygon(Point...)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
List<LineString>	getCoordinates() Returns a list of coordinates for this Geometry type.
LineString	getExteriorBoundary() Returns a LineString representing the exterior boundary of this Polygon.
List<LineString>	getInteriorBoundaries() Returns a (possibly empty) List of LineStrings, one for each hole inside the external boundary of this polygon.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getExteriorBoundary

public LineString getExteriorBoundary()

Returns a LineString representing the exterior boundary of this Polygon. Polygons should have an exterior boundary where the end point is the same as the start point.

Returns:

a LineString containing the points that make up the external boundary of this Polygon.

getInteriorBoundaries

public List<LineString> getInteriorBoundaries()

Returns a (possibly empty) List of LineStrings, one for each hole inside the external boundary of this polygon.

Returns:

a List of LineStrings where each LineString represents an internal boundary or hole.

getCoordinates

public List<LineString> getCoordinates()

Description copied from interface: Geometry

Returns a list of coordinates for this Geometry type. For something like a Point, this will be a pair of lat/long coordinates, but for more complex types this will be a list of other Geometry objects. Used for serialisation to MongoDB.

Specified by:

getCoordinates in interface Geometry

Returns:

a List containing either Geometry objects, or a pair of coordinates as doubles

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object