Package com.marcosavard.commons.geog

Class GeoCoordinate

java.lang.Object

com.marcosavard.commons.geog.GeoCoordinate

All Implemented Interfaces:

java.io.Serializable

public class GeoCoordinate
extends java.lang.Object
implements java.io.Serializable

A class that represent geographical coordinates (latitude and longitude). It provides methods to display coordinates in decimal or degrees/minutes/seconds formats. It computes distance to another geographical coordinate. This class is immutable (values are set at construction, and cannot be modified during the lifetime of an instance.

Author:

Marco

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoCoordinate.Format

Constructor Summary

Constructors

Constructor	Description
GeoCoordinate(double latitude, double longitude)
GeoCoordinate(int latitudeDeg, int latitudeMin, int latitudeSec, int longitudeDeg, int longitudeMin, int longitudeSec)	Create coordinates by latitude and longitude given in degrees, minutes and seconds.

Method Summary

Modifier and Type	Method	Description
double	computeDistanceFrom(GeoCoordinate location)	Compute the distance, in kilometers, between that location.
double	getLatitude()
double	getLongitude()
java.lang.String	toDisplayString()
java.lang.String	toDisplayString(GeoCoordinate.Format format)	Return textual display of a coordinate, according a given format
java.lang.String	toLatitudeString()
java.lang.String	toLongitudeString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GeoCoordinate

public GeoCoordinate(double latitude,
                     double longitude)

GeoCoordinate

public GeoCoordinate(int latitudeDeg,
                     int latitudeMin,
                     int latitudeSec,
                     int longitudeDeg,
                     int longitudeMin,
                     int longitudeSec)

Create coordinates by latitude and longitude given in degrees, minutes and seconds.

Parameters:

latitudeDeg - latitude in degree

latitudeMin - latitude in minute

latitudeSec - latitude in second

longitudeDeg - longitude in degree

longitudeMin - longitude in minute

longitudeSec - longitude in second

Method Detail

getLatitude

public double getLatitude()

getLongitude

public double getLongitude()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDisplayString

public java.lang.String toDisplayString(GeoCoordinate.Format format)

Return textual display of a coordinate, according a given format

Parameters:

format - one of DECIMAL, DEG_MIN_SEC and DEG_MIN_SEC_HTML

Returns:

textual display of a coordinat

toDisplayString

public java.lang.String toDisplayString()

toLatitudeString

public java.lang.String toLatitudeString()

toLongitudeString

public java.lang.String toLongitudeString()

computeDistanceFrom

public double computeDistanceFrom(GeoCoordinate location)

Compute the distance, in kilometers, between that location.

Parameters:

location - to which distance is computed

Returns:

the distance in kilometers