org.vertexium.type

Class GeoCircle

java.lang.Object

org.vertexium.type.GeoShapeBase

org.vertexium.type.GeoCircle

All Implemented Interfaces:

Serializable, GeoShape

public class GeoCircle
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
GeoCircle(double latitude, double longitude, double radius)
GeoCircle(double latitude, double longitude, double radius, String description)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
GeoRect	getBoundingBox()
double	getLatitude()
double	getLongitude()
double	getRadius()
int	hashCode()
boolean	intersects(GeoShape geoShape) Calculate whether the given GeoShape intersects with the geometry of this object.
String	toString()
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, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoCircle

public GeoCircle(double latitude,
                 double longitude,
                 double radius)

Parameters:

latitude - latitude is specified in decimal degrees

longitude - longitude is specified in decimal degrees

radius - radius is specified in kilometers

GeoCircle

public GeoCircle(double latitude,
                 double longitude,
                 double radius,
                 String description)

Parameters:

latitude - latitude is specified in decimal degrees

longitude - longitude is specified in decimal degrees

radius - radius is specified in kilometers

description - name or description of this shape

Method Detail

getLatitude

public double getLatitude()

getLongitude

public double getLongitude()

getRadius

public double getRadius()

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.

getBoundingBox

public GeoRect getBoundingBox()

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