org.vertexium.type

Class GeoPoint

java.lang.Object

org.vertexium.type.GeoShapeBase

org.vertexium.type.GeoPoint

All Implemented Interfaces:

Serializable, Comparable<GeoPoint>, GeoShape

public class GeoPoint
extends GeoShapeBase
implements Comparable<GeoPoint>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static double	EQUALS_TOLERANCE_KM

Fields inherited from class org.vertexium.type.GeoShapeBase

EARTH_CIRCUMFERENCE, EARTH_RADIUS, MAX_LAT, MAX_LON, MIN_LAT, MIN_LON

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeoPoint() Create a geopoint at 0, 0 with an altitude of 0
	GeoPoint(double latitude, double longitude)
	GeoPoint(double latitude, double longitude, Double altitude)
	GeoPoint(double latitude, double longitude, Double altitude, String description)
	GeoPoint(double latitude, double longitude, String description)

Method Summary

Modifier and Type	Method and Description
static GeoPoint	calculateCenter(List<GeoPoint> geoPoints) For large distances center point calculation has rounding errors
int	compareTo(GeoPoint other)
static double	distanceBetween(GeoPoint geoPoint1, GeoPoint geoPoint2)
double	distanceFrom(GeoPoint geoPoint)
boolean	equals(Object obj)
Double	getAltitude()
double	getLatitude()
double	getLongitude()
int	hashCode()
boolean	intersects(GeoShape geoShape) Calculate whether the given GeoShape intersects with the geometry of this object.
boolean	isNorthOf(GeoPoint pt)
boolean	isNorthWestOf(GeoPoint pt)
boolean	isSouthEastOf(GeoPoint pt)
boolean	isSouthOf(GeoPoint pt)
double	longitudinalDistanceTo(GeoPoint pt)
static GeoPoint	parse(String str)
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

Field Detail

EQUALS_TOLERANCE_KM

public static final double EQUALS_TOLERANCE_KM

See Also:

Constant Field Values

Constructor Detail

GeoPoint

protected GeoPoint()

Create a geopoint at 0, 0 with an altitude of 0

GeoPoint

public GeoPoint(double latitude,
                double longitude,
                Double altitude,
                String description)

Parameters:

latitude - latitude is specified in decimal degrees

longitude - longitude is specified in decimal degrees

altitude - altitude is specified in kilometers

description - name or description of this shape

GeoPoint

public GeoPoint(double latitude,
                double longitude,
                Double altitude)

GeoPoint

public GeoPoint(double latitude,
                double longitude)

GeoPoint

public GeoPoint(double latitude,
                double longitude,
                String description)

Method Detail

getLatitude

public double getLatitude()

getLongitude

public double getLongitude()

getAltitude

public Double getAltitude()

toString

public String toString()

Overrides:

toString in class Object

intersects

public boolean intersects(GeoShape geoShape)

Description copied from interface: GeoShape

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

Specified by:

intersects in interface GeoShape

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.

Specified by:

within in interface GeoShape

Parameters:

geoShape - The other shape

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

distanceBetween

public static double distanceBetween(GeoPoint geoPoint1,
                                     GeoPoint geoPoint2)

distanceFrom

public double distanceFrom(GeoPoint geoPoint)

compareTo

public int compareTo(GeoPoint other)

Specified by:

compareTo in interface Comparable<GeoPoint>

parse

public static GeoPoint parse(String str)

isSouthEastOf

public boolean isSouthEastOf(GeoPoint pt)

isSouthOf

public boolean isSouthOf(GeoPoint pt)

isNorthWestOf

public boolean isNorthWestOf(GeoPoint pt)

longitudinalDistanceTo

public double longitudinalDistanceTo(GeoPoint pt)

isNorthOf

public boolean isNorthOf(GeoPoint pt)

calculateCenter

public static GeoPoint calculateCenter(List<GeoPoint> geoPoints)

For large distances center point calculation has rounding errors