org.deegree.cs.coordinatesystems
Class CoordinateSystem

java.lang.Object
  org.deegree.cs.CRSIdentifiable
      org.deegree.cs.coordinatesystems.CoordinateSystem

Direct Known Subclasses:

CompoundCRS, GeocentricCRS, GeographicCRS, ProjectedCRS, VerticalCRS

public abstract class CoordinateSystem
extends CRSIdentifiable

Three kinds of CoordinateSystems (in this class abbreviated with CRS) are supported in this lib.

• Geographic CRS: A position (on the ellipsoid) is given in Lattitude / Longitude (Polar Cooridnates) given in rad° min''sec. The order of the position's coordinates are to be contrued to the axis order of the CRS. These lat/lon coordinates are to be tranformed to x,y,z values to define their location on the underlying datum.
• GeoCentric CRS: A position (on the ellipsoid) is given in x, y, z (cartesian) coordinates with the same units defined as the ones in the underlying datum. The order of the position's coordinates are to be contrued to the axis order of the datum.
• Projected CRS: The position (on the map) is given in a 2D-tuple in pre-defined units. The Axis of the CRS are defined (through a transformation) for an underlying Datum, which can have it's own axis with their own units. The order of the position's coordinates are to be contrued to the axis order of the CRS

Summarizing it can be said, that each CRS has following features

• A reference code (an casesensitive String identifying this CRS, for example 'EPGS:4326' or 'urn:ogc:def:crs:OGC:2:84' or 'luref')
• An optional version.
• A humanly readable name.
• An optional description.
• An optional area of use, describing where this CRS is used.
• The order in which the axis of ther crs are defined.
• The underlying Datum

Version:

$Revision$, $Date$

Author:

Rutger Bezema, last edited by: $Author$

Nested Class Summary

static class

CoordinateSystem.CRSType Simple enum defining the currently known Coordinate System types.

Constructor Summary

CoordinateSystem(Datum datum, Axis[] axisOrder, CRSCodeType[] codes, java.lang.String[] names, java.lang.String[] versions, java.lang.String[] descriptions, java.lang.String[] areasOfUse)


CoordinateSystem(Datum datum, Axis[] axisOrder, CRSIdentifiable identity)


CoordinateSystem(java.util.List<Transformation> transformations, Datum datum, Axis[] axisOrder, CRSIdentifiable identity)


Method Summary

javax.vecmath.Point3d	convertToAxis(javax.vecmath.Point3d coordinates, Unit[] units, boolean invert) Converts the given coordinates in given to the unit of the respective axis.
boolean	equals(java.lang.Object other)
Axis[]	getAxis()
Datum	getDatum()
abstract int	getDimension()
Transformation	getDirectTransformation(CoordinateSystem targetCRS)
int	getEasting() Return the axis index associated with an easting value, if the axis could not be determined Axis.AO_OTHER 0 will be returned.
GeodeticDatum	getGeodeticDatum()
int	getNorthing() Return the axis index associated with a northing value, if the axis could not be determined (e.g not is Axis.AO_NORTH Axis.AO_SOUTH or Axis.AO_UP or Axis.AO_DOWN) 1 will be returned.
java.util.List<Transformation>	getTransformations()
abstract CoordinateSystem.CRSType	getType()
protected java.lang.String	getTypeName() Helper function to get the typename as a String.
Unit[]	getUnits()
double[]	getValidDomain() Returns the approximate domain of validity of this coordinate system.
boolean	hasDirectTransformation(CoordinateSystem targetCRS)
int	hashCode() Implementation as proposed by Joshua Block in Effective Java (Addison-Wesley 2001), which supplies an even distribution and is relatively fast.
java.lang.String	toString()

Methods inherited from class org.deegree.cs.CRSIdentifiable

addAreaOfUse, addName, checkForNullObject, checkForNullObject, checkForNullObject, getAreaOfUse, getAreaOfUseBBox, getAreasOfUse, getCode, getCodeAndName, getCodes, getDescription, getDescriptions, getName, getNames, getOrignalCodeStrings, getVersion, getVersions, hasCode, hasId, hasIdOrName, setDefaultAreaOfUse, setDefaultDescription, setDefaultId, setDefaultName, setDefaultVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinateSystem

public CoordinateSystem(Datum datum,
                        Axis[] axisOrder,
                        CRSIdentifiable identity)

Parameters:

datum - of this coordinate system.

axisOrder - the axisorder of this coordinate system.

identity -

CoordinateSystem

public CoordinateSystem(Datum datum,
                        Axis[] axisOrder,
                        CRSCodeType[] codes,
                        java.lang.String[] names,
                        java.lang.String[] versions,
                        java.lang.String[] descriptions,
                        java.lang.String[] areasOfUse)

Parameters:

datum - of this coordinate system.

axisOrder - the axisorder of this coordinate system.

codes - of this coordinate system.

names -

versions -

descriptions -

areasOfUse -

CoordinateSystem

public CoordinateSystem(java.util.List<Transformation> transformations,
                        Datum datum,
                        Axis[] axisOrder,
                        CRSIdentifiable identity)

Parameters:

transformations - to use instead of the helmert transformation(s).

datum - of this crs

axisOrder -

identity -

Method Detail

getAxis

public Axis[] getAxis()

Returns:

(all) axis' in their defined order.

getGeodeticDatum

public final GeodeticDatum getGeodeticDatum()

Returns:

the usedDatum or null if the datum was not a Geodetic one.

getDatum

public final Datum getDatum()

Returns:

the datum of this coordinate system.

getUnits

public Unit[] getUnits()

Returns:

the units of all axis of the coordinatesystem.

getDimension

public abstract int getDimension()

Returns:

the dimension of this CRS.

getType

public abstract CoordinateSystem.CRSType getType()

Returns:

one of the *_CRS types defined in this class.

hasDirectTransformation

public boolean hasDirectTransformation(CoordinateSystem targetCRS)

Parameters:

targetCRS - to get the alternative Transformation for.

Returns:

true if this crs has an alternative transformation for the given coordinatesystem, false otherwise.

getDirectTransformation

public Transformation getDirectTransformation(CoordinateSystem targetCRS)

Parameters:

targetCRS - to get the alternative transformation for.

Returns:

the transformation associated with the given crs, null otherwise.

convertToAxis

public javax.vecmath.Point3d convertToAxis(javax.vecmath.Point3d coordinates,
                                           Unit[] units,
                                           boolean invert)

Converts the given coordinates in given to the unit of the respective axis.

Parameters:

coordinates - to convert to.

units - in which the coordinates were given.

invert - if the operation should be inverted, e.g. the coordinates are given in the axis units and should be converted to the given units.

Returns:

the converted coordinates.

getTypeName

protected java.lang.String getTypeName()

Helper function to get the typename as a String.

Returns:

either the type as a name or 'Unknown' if the type is not known.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class CRSIdentifiable

hashCode

public int hashCode()

Implementation as proposed by Joshua Block in Effective Java (Addison-Wesley 2001), which supplies an even distribution and is relatively fast. It is created from field f as follows:

• boolean -- code = (f ? 0 : 1)
• byte, char, short, int -- code = (int)f
• long -- code = (int)(f ^ (f >>>32))
• float -- code = Float.floatToIntBits(f);
• double -- long l = Double.doubleToLongBits(f); code = (int)(l ^ (l >>> 32))
• all Objects, (where equals( ) calls equals( ) for this field) -- code = f.hashCode( )
• Array -- Apply above rules to each element

Combining the hash code(s) computed above: result = 37 * result + code;

Overrides:

hashCode in class CRSIdentifiable

Returns:

(int) ( result >>> 32 ) ^ (int) result;

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Overrides:

toString in class CRSIdentifiable

getTransformations

public final java.util.List<Transformation> getTransformations()

Returns:

the polynomial transformations.

getEasting

public int getEasting()

Return the axis index associated with an easting value, if the axis could not be determined Axis.AO_OTHER 0 will be returned.

Returns:

the index of the axis which represents the easting/westing component of a coordinate tuple.

getNorthing

public int getNorthing()

Return the axis index associated with a northing value, if the axis could not be determined (e.g not is Axis.AO_NORTH Axis.AO_SOUTH or Axis.AO_UP or Axis.AO_DOWN) 1 will be returned.

Returns:

the index of the axis which represents the easting/westing component of a coordinate tuple.

getValidDomain

public double[] getValidDomain()

Returns the approximate domain of validity of this coordinate system. The returned array will contain the values in the appropriate coordinate system and with the appropriate axis order.

Returns:

the real world coordinates of the domain of validity of this crs, or null if the valid domain could not be determined