org.vertexium.type

Class GeoPolygon

java.lang.Object

org.vertexium.type.GeoShapeBase

org.vertexium.type.GeoPolygon

All Implemented Interfaces:

Serializable, GeoShape

public class GeoPolygon
extends GeoShapeBase

See Also:

Serialized Form

Field Summary

Fields inherited from class org.vertexium.type.GeoShapeBase

EARTH_CIRCUMFERENCE, EARTH_RADIUS, MAX_LAT, MAX_LON, MIN_LAT, MIN_LON

Constructor Summary

Constructors

Constructor and Description
GeoPolygon(List<GeoPoint> outerBoundary)
GeoPolygon(List<GeoPoint> outerBoundary, List<List<GeoPoint>> holeBoundaries)
GeoPolygon(List<GeoPoint> outerBoundary, List<List<GeoPoint>> holeBoundaries, String description)
GeoPolygon(List<GeoPoint> outerBoundary, String description)

Method Summary

Modifier and Type	Method and Description
GeoPolygon	addHole(List<GeoPoint> geoPoints)
boolean	equals(Object obj)
List<List<GeoPoint>>	getHoles()
List<GeoPoint>	getOuterBoundary()
int	hashCode()
boolean	intersects(GeoShape geoShape) Calculate whether the given GeoShape intersects with the geometry of this object.
String	toString()
void	validate() Throw a VertexiumException if the requirements for this shape are not met.
boolean	within(GeoShape geoShape) Calculate whether the given GeoShape is completely within the geometry of this object.

Methods inherited from class org.vertexium.type.GeoShapeBase

distanceBetween, getDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoPolygon

public GeoPolygon(List<GeoPoint> outerBoundary)

Parameters:

outerBoundary - A list of geopoints that make up the outer boundary of this shape. To avoid ambiguity, the points must be specified in counter-clockwise order. In addition, the first and last point specified must match.

GeoPolygon

public GeoPolygon(List<GeoPoint> outerBoundary,
                  String description)

Parameters:

outerBoundary - A list of geopoints that make up the outer boundary of this shape. To avoid ambiguity, the points must be specified in counter-clockwise order. In addition, the first and last point specified must match.

description - name or description of this shape

GeoPolygon

public GeoPolygon(List<GeoPoint> outerBoundary,
                  List<List<GeoPoint>> holeBoundaries)

Parameters:

outerBoundary - A list of geopoints that make up the outer boundary of this shape. To avoid ambiguity, the points must be specified in counter-clockwise order. In addition, the first and last point specified must match.

holeBoundaries - A list of geopoint lists that make up the holes in this shape. To avoid ambiguity, the points must be specified in clockwise order. In addition, the first and last point specified must match.

GeoPolygon

public GeoPolygon(List<GeoPoint> outerBoundary,
                  List<List<GeoPoint>> holeBoundaries,
                  String description)

Parameters:

outerBoundary - A list of geopoints that make up the outer boundary of this shape. To avoid ambiguity, the points must be specified in counter-clockwise order. In addition, the first and last point specified must match.

holeBoundaries - A list of geopoint lists that make up the holes in this shape. To avoid ambiguity, the points must be specified in clockwise order. In addition, the first and last point specified must match.

description - name or description of this shape

Method Detail

intersects

public boolean intersects(GeoShape geoShape)

Description copied from interface: GeoShape

Calculate whether the given GeoShape intersects with the geometry of this object.

Parameters:

geoShape - The other shape

Returns:

True if any points of the provided shape are within the geometry of this shape or vice-versa.

within

public boolean within(GeoShape geoShape)

Description copied from interface: GeoShape

Calculate whether the given GeoShape is completely within the geometry of this object.

Parameters:

geoShape - The other shape

Returns:

True if the provided shape is completely within the geometry of this shape.

validate

public void validate()

Description copied from interface: GeoShape

Throw a VertexiumException if the requirements for this shape are not met.

Specified by:

validate in interface GeoShape

Overrides:

validate in class GeoShapeBase

getOuterBoundary

public List<GeoPoint> getOuterBoundary()

addHole

public GeoPolygon addHole(List<GeoPoint> geoPoints)

getHoles

public List<List<GeoPoint>> getHoles()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object