com.eatthepath.jeospatial

Interface GeospatialPoint

All Known Implementing Classes:

SimpleGeospatialPoint

public interface GeospatialPoint

A geospatial point is a single point on the earth's surface.

Author:

Jon Chambers

Field Summary

Fields

Modifier and Type	Field and Description
static double	EARTH_RADIUS The radius of the earth in meters; all implementing whose distance calculations rely upon the radius of the earth should reference this value.

Method Summary

Methods

Modifier and Type	Method and Description
double	getDistanceTo(double latitude, double longitude) Calculates the "great circle" or orthometric distance between this point and another point on the earth's surface.
double	getDistanceTo(GeospatialPoint otherPoint) Calculates the "great circle" or orthometric distance between this point and another point on the earth's surface.
double	getLatitude() Returns the latitude of this point.
double	getLongitude() Returns the longitude of this point.

Field Detail

EARTH_RADIUS

static final double EARTH_RADIUS

The radius of the earth in meters; all implementing whose distance calculations rely upon the radius of the earth should reference this value.

The earth, for the purposes of this library, is considered to be a sphere with a radius of 6371000.0 meters.

See Also:

getDistanceTo(GeospatialPoint), Constant Field Values

Method Detail

getLatitude

double getLatitude()

Returns the latitude of this point.

Returns:

the latitude of this point in degrees

getLongitude

double getLongitude()

Returns the longitude of this point. The returned longitude should be normalized to the range -180 degrees (inclusive) to 180 degrees (exclusive).

Returns:

the longitude of this point in degrees

getDistanceTo

double getDistanceTo(GeospatialPoint otherPoint)

Calculates the "great circle" or orthometric distance between this point and another point on the earth's surface. The great circle distance is the minimum distance traveled to get from one point to the next on the surface of the earth.

Implementations of this method that incorporate the radius of the earth should reference the EARTH_RADIUS property of this interface.

Parameters:

otherPoint - the other point to which to calculate distance

Returns:

the great circle distance between the two points in meters

See Also:

EARTH_RADIUS

getDistanceTo

double getDistanceTo(double latitude,
                   double longitude)

Calculates the "great circle" or orthometric distance between this point and another point on the earth's surface. The great circle distance is the minimum distance traveled to get from one point to the next on the surface of the earth.

Implementations of this method that incorporate the radius of the earth should reference the EARTH_RADIUS property of this interface.

Parameters:

latitude - the latitude, in degrees, of the other point to which to calculate distance

longitude - the longitude, in degrees, of the other point to which to calculate distance

Returns:

the great circle distance between the two points in meters

See Also:

EARTH_RADIUS