org.vertexium.type

Interface GeoShape

All Known Implementing Classes:

GeoCircle, GeoCollection, GeoHash, GeoLine, GeoPoint, GeoPolygon, GeoRect, GeoShapeBase

public interface GeoShape

Method Summary

Modifier and Type	Method and Description
String	getDescription()
boolean	intersects(GeoShape geoShape) Calculate whether the given GeoShape intersects with the geometry of this object.
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.

Method Detail

intersects

boolean intersects(GeoShape 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

boolean within(GeoShape 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

void validate()

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

getDescription

String getDescription()