com.bigdata.rdf.internal.gis

Class CoordinateDD

java.lang.Object

com.bigdata.rdf.internal.gis.CoordinateDD

All Implemented Interfaces:

ICoordinate

public class CoordinateDD
extends Object
implements ICoordinate

An immutable coordinate expressed as double precision decimal degrees on the surface of (the Earth's) sphere.

Version:

$Id$

Author:

Bryan Thompson

Nested Class Summary

Nested classes/interfaces inherited from interface com.bigdata.rdf.internal.gis.ICoordinate

ICoordinate.UNITS

Field Summary

Fields

Modifier and Type	Field and Description
double	eastWest Decimal degrees east (or west iff negative).
double	northSouth Decimal degrees north (or south iff negative).

Constructor Summary

Constructors

Constructor and Description
CoordinateDD(double northSouth, double eastWest) Constructor for a coordinate using decimal degrees.
CoordinateDD(double northSouth, double eastWest, boolean adjustToMinMax) Constructor for a coordinate using decimal degrees.

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(ICoordinate o, ICoordinate.UNITS units) Computes the distance to the specified coordinate and returns that distance in the specified units.
boolean	equals(CoordinateDD o) True iff the two coordinates are exactly the same.
boolean	equals(ICoordinate o) Return true if two coordinates are exactly the same.
static CoordinateDD	parse(String text) Parses coordinates expressed in decimal degrees.
CoordinateDD	toDD() Convert to decimal degrees.
CoordinateDDM	toDDM() Convert to degrees and decimal minutes.
CoordinateDMS	toDMS() Convert to degrees, minutes and (tenths of) seconds.
String	toString() Returns the coordinate in decimal degrees as

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

northSouth

public final double northSouth

Decimal degrees north (or south iff negative).

eastWest

public final double eastWest

Decimal degrees east (or west iff negative).

Constructor Detail

CoordinateDD

public CoordinateDD(double northSouth,
            double eastWest)

Constructor for a coordinate using decimal degrees.

Parameters:

northSouth - Decimal degrees north (or south iff negative). The range is [-90:+90].

eastWest - Decimal degrees east (or west iff negative). The range is (-180:+180]. Note that a value of 180W is normalized to 180E by this constructor.

Throws:

IllegalArgumentException - if northSouth is out of the range [-90:+90].

IllegalArgumentException - if eastWest is out of the range [-180:+180].

CoordinateDD

public CoordinateDD(double northSouth,
            double eastWest,
            boolean adjustToMinMax)

Constructor for a coordinate using decimal degrees.

Parameters:

northSouth - Decimal degrees north (or south iff negative). The range is [-90:+90].

eastWest - Decimal degrees east (or west iff negative). The range is (-180:+180].

adjustToMinMax - If this parameter is set to true we may pass in values that are out of range. Such values are adjusted to the respective MIN and MAX values. If set to false, exceptions are thrown.

Throws:

IllegalArgumentException - if adjustToMinMax is false AND northSouth is out of the range [-90:+90].

IllegalArgumentException - if adjustToMinMax is false AND if eastWest is out of the range [-180:+180].

Method Detail

toString

public String toString()

Returns the coordinate in decimal degrees as

  +32.30642, -122.61458
 

Overrides:

toString in class Object

parse

public static CoordinateDD parse(String text)
                          throws ParseException

Parses coordinates expressed in decimal degrees. For example

 36.07263, -79.79197
 
 36.07263/-79.79197
 
 36.07263 -79.79197
 
 +36.0726355 -79.7919754
 

Parameters:

text - The text.

Returns:

A coordinate

Throws:

ParseException

equals

public boolean equals(ICoordinate o)

Description copied from interface: ICoordinate

Return true if two coordinates are exactly the same.

Note: Coordinates MUST be expressed in the same system before they may be compared. E.g., Degrees, Minutes and Seconds or Degrees and Decimal Minutes or Decimal Degrees.

Specified by:

equals in interface ICoordinate

Parameters:

o - Another coordinate.

equals

public boolean equals(CoordinateDD o)

True iff the two coordinates are exactly the same.

Parameters:

o -

Returns:

toDMS

public CoordinateDMS toDMS()

Convert to degrees, minutes and (tenths of) seconds.

Specified by:

toDMS in interface ICoordinate

Returns:

The coordinate expressed as degrees, minutes and (tenths of) seconds.

distance

public double distance(ICoordinate o,
              ICoordinate.UNITS units)

Description copied from interface: ICoordinate

Computes the distance to the specified coordinate and returns that distance in the specified units.

Specified by:

distance in interface ICoordinate

Parameters:

o - Another coordinate.

units - The units in which the distance will be reported.

Returns:

The distance in the specified units.

toDDM

public CoordinateDDM toDDM()

Description copied from interface: ICoordinate

Convert to degrees and decimal minutes.

Specified by:

toDDM in interface ICoordinate

Returns:

The coordinate expressed as degrees and decimal minutes.

toDD

public CoordinateDD toDD()

Description copied from interface: ICoordinate

Convert to decimal degrees.

Specified by:

toDD in interface ICoordinate

Returns:

The coordinate expressed as decimal degrees.