org.geotools.referencing.cs
Class DefaultCoordinateSystemAxis

java.lang.Object
  org.geotools.referencing.wkt.Formattable
      org.geotools.referencing.AbstractIdentifiedObject
          org.geotools.referencing.cs.DefaultCoordinateSystemAxis

All Implemented Interfaces:

org.opengis.referencing.cs.CoordinateSystemAxis, org.opengis.referencing.IdentifiedObject, java.io.Serializable

public class DefaultCoordinateSystemAxis

extends AbstractIdentifiedObject

implements org.opengis.referencing.cs.CoordinateSystemAxis

Definition of a coordinate system axis. This is used to label axes, and indicate the orientation. See axis name constraints.

In some case, the axis name is constrained by ISO 19111 depending on the coordinate reference system type. These constraints are identified in the javadoc by "ISO 19111 name is..." sentences. This constraint works in two directions; for example the names "geodetic latitude" and "geodetic longitude" shall be used to designate the coordinate axis names associated with a geographic coordinate reference system. Conversely, these names shall not be used in any other context.

Since:

2.1

Version:

$Id: DefaultCoordinateSystemAxis.java 17902 2006-02-07 09:50:07Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

AbstractCS, Unit, Serialized Form

Field Summary

static DefaultCoordinateSystemAxis	ALTITUDE The default axis for altitude values.
static DefaultCoordinateSystemAxis	COLUMN A default axis for column indices in a grid coverage.
static DefaultCoordinateSystemAxis	DEPTH The default axis for depth.
static DefaultCoordinateSystemAxis	DISPLAY_X A default axis for x values in a display device.
static DefaultCoordinateSystemAxis	DISPLAY_Y A default axis for y values in a display device.
static DefaultCoordinateSystemAxis	EASTING Default axis info for Easting values in a projected CRS.
static DefaultCoordinateSystemAxis	ELLIPSOIDAL_HEIGHT The default axis for height values above the ellipsoid in a geographic CRS.
static DefaultCoordinateSystemAxis	GEOCENTRIC_RADIUS Default axis info for radius in a geocentric CRS using spherical CS.
static DefaultCoordinateSystemAxis	GEOCENTRIC_X Default axis info for x values in a geocentric CRS using cartesian CS.
static DefaultCoordinateSystemAxis	GEOCENTRIC_Y Default axis info for y values in a geocentric CRS using cartesian CS.
static DefaultCoordinateSystemAxis	GEOCENTRIC_Z Default axis info for z values in a geocentric CRS using cartesian CS.
static DefaultCoordinateSystemAxis	GEODETIC_LATITUDE Default axis info for geodetic latitudes in a geographic CRS.
static DefaultCoordinateSystemAxis	GEODETIC_LONGITUDE Default axis info for geodetic longitudes in a geographic CRS.
static DefaultCoordinateSystemAxis	GRAVITY_RELATED_HEIGHT The default axis for height values measured from gravity.
static DefaultCoordinateSystemAxis	LATITUDE Default axis info for latitudes.
static DefaultCoordinateSystemAxis	LONGITUDE Default axis info for longitudes.
static DefaultCoordinateSystemAxis	NORTHING Default axis info for Northing values in a projected CRS.
static DefaultCoordinateSystemAxis	ROW A default axis for row indices in a grid coverage.
static DefaultCoordinateSystemAxis	SOUTHING Default axis info for Southing values in a projected CRS.
static DefaultCoordinateSystemAxis	SPHERICAL_LATITUDE Default axis info for latitudes in a geocentric CRS using spherical CS.
static DefaultCoordinateSystemAxis	SPHERICAL_LONGITUDE Default axis info for longitudes in a geocentric CRS using spherical CS.
static DefaultCoordinateSystemAxis	TIME A default axis for time values in a time CS.
static DefaultCoordinateSystemAxis	WESTING Default axis info for Westing values in a projected CRS.
static DefaultCoordinateSystemAxis	X Default axis info for x values in a cartesian CS.
static DefaultCoordinateSystemAxis	Y Default axis info for y values in a cartesian CS.
static DefaultCoordinateSystemAxis	Z Default axis info for z values in a cartesian CS.

Fields inherited from class org.geotools.referencing.AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultCoordinateSystemAxis(org.opengis.referencing.cs.CoordinateSystemAxis axis)
Constructs a new coordinate system axis with the same values than the specified one.

DefaultCoordinateSystemAxis(org.opengis.util.InternationalString name, java.lang.String abbreviation, org.opengis.referencing.cs.AxisDirection direction, javax.units.Unit unit)
Constructs an axis with a name as an international string and an abbreviation.

DefaultCoordinateSystemAxis(java.util.Map properties, java.lang.String abbreviation, org.opengis.referencing.cs.AxisDirection direction, javax.units.Unit unit)
Constructs an axis from a set of properties.

DefaultCoordinateSystemAxis(java.lang.String abbreviation, org.opengis.referencing.cs.AxisDirection direction, javax.units.Unit unit)
Constructs an axis with the same name as the abbreviation.

Method Summary

boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata) Compares the specified object with this axis for equality.
protected java.lang.String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.
java.lang.String	getAbbreviation() The abbreviation used for this coordinate system axes.
org.opengis.referencing.cs.AxisDirection	getDirection() Direction of this coordinate system axis.
static org.opengis.referencing.cs.AxisDirection	getDirection(java.lang.String direction) Returns an axis direction constants from its name.
javax.units.Unit	getUnit() The unit of measure used for this coordinate system axis.
int	hashCode() Returns a hash value for this axis.

Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches

Methods inherited from class org.geotools.referencing.wkt.Formattable

toString, toWKT, toWKT, toWKT

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

LONGITUDE

public static final DefaultCoordinateSystemAxis LONGITUDE

Default axis info for longitudes. Increasing ordinates values go East and units are degrees. The abbreviation is "λ" (lambda). This axis is usually part of a LONGITUDE, LATITUDE, ALTITUDE set.

See Also:

GEODETIC_LONGITUDE, SPHERICAL_LONGITUDE, LATITUDE

LATITUDE

public static final DefaultCoordinateSystemAxis LATITUDE

Default axis info for latitudes. Increasing ordinates values go North and units are degrees. The abbreviation is "φ" (phi). This axis is usually part of a LONGITUDE, LATITUDE, ALTITUDE set.

See Also:

GEODETIC_LATITUDE, SPHERICAL_LATITUDE, LONGITUDE

ALTITUDE

public static final DefaultCoordinateSystemAxis ALTITUDE

The default axis for altitude values. Increasing ordinates values go up and units are metres. The abbreviation is lower case "h". This axis is usually part of a LONGITUDE, LATITUDE, ALTITUDE set.

See Also:

ELLIPSOIDAL_HEIGHT, GEOCENTRIC_RADIUS, GRAVITY_RELATED_HEIGHT, DEPTH

DEPTH

public static final DefaultCoordinateSystemAxis DEPTH

The default axis for depth. Increasing ordinates values go down and units are metres. The ISO 19111 name is "depth".

See Also:

ALTITUDE, ELLIPSOIDAL_HEIGHT, GEOCENTRIC_RADIUS, GRAVITY_RELATED_HEIGHT

GEODETIC_LONGITUDE

public static final DefaultCoordinateSystemAxis GEODETIC_LONGITUDE

Default axis info for geodetic longitudes in a geographic CRS. Increasing ordinates values go East and units are degrees. The ISO 19111 name is "geodetic longitude" and the abbreviation is "λ" (lambda). This axis is usually part of a GEODETIC_LONGITUDE, GEODETIC_LATITUDE, ELLIPSOIDAL_HEIGHT set.

See Also:

LONGITUDE, SPHERICAL_LONGITUDE, GEODETIC_LATITUDE

GEODETIC_LATITUDE

public static final DefaultCoordinateSystemAxis GEODETIC_LATITUDE

Default axis info for geodetic latitudes in a geographic CRS. Increasing ordinates values go North and units are degrees. The ISO 19111 name is "geodetic latitude" and the abbreviation is "φ" (phi). This axis is usually part of a GEODETIC_LONGITUDE, GEODETIC_LATITUDE, ELLIPSOIDAL_HEIGHT set.

See Also:

LATITUDE, SPHERICAL_LATITUDE, GEODETIC_LONGITUDE

ELLIPSOIDAL_HEIGHT

public static final DefaultCoordinateSystemAxis ELLIPSOIDAL_HEIGHT

The default axis for height values above the ellipsoid in a geographic CRS. Increasing ordinates values go up and units are metres. The ISO 19111 name is "ellipsoidal heigt" and the abbreviation is lower case "h". This axis is usually part of a GEODETIC_LONGITUDE, GEODETIC_LATITUDE, ELLIPSOIDAL_HEIGHT set.

See Also:

ALTITUDE, GEOCENTRIC_RADIUS, GRAVITY_RELATED_HEIGHT, DEPTH

GRAVITY_RELATED_HEIGHT

public static final DefaultCoordinateSystemAxis GRAVITY_RELATED_HEIGHT

The default axis for height values measured from gravity. Increasing ordinates values go up and units are metres. The ISO 19111 name is "gravity-related height" and the abbreviation is lower case "h".

See Also:

ALTITUDE, ELLIPSOIDAL_HEIGHT, GEOCENTRIC_RADIUS, DEPTH

GEOCENTRIC_RADIUS

public static final DefaultCoordinateSystemAxis GEOCENTRIC_RADIUS

Default axis info for radius in a geocentric CRS using spherical CS. Increasing ordinates values go up and units are metres. The ISO 19111 name is "geocentric radius" and the abbreviation is lower case "r". This axis is usually part of a SPHERICAL_LONGITUDE, SPHERICAL_LATITUDE, GEOCENTRIC_RADIUS set.

See Also:

ALTITUDE, ELLIPSOIDAL_HEIGHT, GRAVITY_RELATED_HEIGHT, DEPTH

SPHERICAL_LONGITUDE

public static final DefaultCoordinateSystemAxis SPHERICAL_LONGITUDE

Default axis info for longitudes in a geocentric CRS using spherical CS. Increasing ordinates values go East and units are degrees. The ISO 19111 name is "spherical longitude" and the abbreviation is "Ω" (omega). This axis is usually part of a SPHERICAL_LONGITUDE, SPHERICAL_LATITUDE, GEOCENTRIC_RADIUS set.

See Also:

LONGITUDE, GEODETIC_LONGITUDE, SPHERICAL_LATITUDE

SPHERICAL_LATITUDE

public static final DefaultCoordinateSystemAxis SPHERICAL_LATITUDE

Default axis info for latitudes in a geocentric CRS using spherical CS. Increasing ordinates values go North and units are degrees. The ISO 19111 name is "spherical latitude" and the abbreviation is "Θ" (theta). This axis is usually part of a SPHERICAL_LONGITUDE, SPHERICAL_LATITUDE, GEOCENTRIC_RADIUS set.

See Also:

LATITUDE, GEODETIC_LATITUDE, SPHERICAL_LONGITUDE

X

public static final DefaultCoordinateSystemAxis X

Default axis info for x values in a cartesian CS. Increasing ordinates values go East and units are metres. The abbreviation is lower case "x". This axis is usually part of a X, Y, Z set.

See Also:

EASTING, WESTING, GEOCENTRIC_X, DISPLAY_X, COLUMN

Y

public static final DefaultCoordinateSystemAxis Y

Default axis info for y values in a cartesian CS. Increasing ordinates values go North and units are metres. The abbreviation is lower case "y". This axis is usually part of a X, Y, Z set.

See Also:

NORTHING, SOUTHING, GEOCENTRIC_Y, DISPLAY_Y, ROW

Z

public static final DefaultCoordinateSystemAxis Z

Default axis info for z values in a cartesian CS. Increasing ordinates values go up and units are metres. The abbreviation is lower case "z". This axis is usually part of a X, Y, Z set.

GEOCENTRIC_X

public static final DefaultCoordinateSystemAxis GEOCENTRIC_X

Default axis info for x values in a geocentric CRS using cartesian CS. Increasing ordinates values go toward prime meridian and units are metres. The ISO 19111 name is "geocentric X" and the abbreviation is upper case "X". This axis is usually part of a GEOCENTRIC_X, GEOCENTRIC_Y, GEOCENTRIC_Z set.

GEOCENTRIC_Y

public static final DefaultCoordinateSystemAxis GEOCENTRIC_Y

Default axis info for y values in a geocentric CRS using cartesian CS. Increasing ordinates values go East and units are metres. The ISO 19111 name is "geocentric Y" and the abbreviation is upper case "Y". This axis is usually part of a GEOCENTRIC_X, GEOCENTRIC_Y, GEOCENTRIC_Z set.

GEOCENTRIC_Z

public static final DefaultCoordinateSystemAxis GEOCENTRIC_Z

Default axis info for z values in a geocentric CRS using cartesian CS. Increasing ordinates values go North and units are metres. The ISO 19111 name is "geocentric Z" and the abbreviation is upper case "Z". This axis is usually part of a GEOCENTRIC_X, GEOCENTRIC_Y, GEOCENTRIC_Z set.

EASTING

public static final DefaultCoordinateSystemAxis EASTING

Default axis info for Easting values in a projected CRS. Increasing ordinates values go East and units are metres. The ISO 19111 name is "easting" and the abbreviation is upper case "E". This axis is usually part of a EASTING, NORTHING set.

See Also:

X, EASTING, WESTING

WESTING

public static final DefaultCoordinateSystemAxis WESTING

Default axis info for Westing values in a projected CRS. Increasing ordinates values go West and units are metres. The ISO 19111 name is "westing" and the abbreviation is upper case "W".

See Also:

X, EASTING, WESTING

NORTHING

public static final DefaultCoordinateSystemAxis NORTHING

Default axis info for Northing values in a projected CRS. Increasing ordinates values go North and units are metres. The ISO 19111 name is "northing" and the abbreviation is upper case "N". This axis is usually part of a EASTING, NORTHING set.

See Also:

Y, NORTHING, SOUTHING

SOUTHING

public static final DefaultCoordinateSystemAxis SOUTHING

Default axis info for Southing values in a projected CRS. Increasing ordinates values go South and units are metres. The ISO 19111 name is "southing" and the abbreviation is upper case "S".

See Also:

Y, NORTHING, SOUTHING

TIME

public static final DefaultCoordinateSystemAxis TIME

A default axis for time values in a time CS. Increasing time go toward future and units are days. The abbreviation is lower case "t".

COLUMN

public static final DefaultCoordinateSystemAxis COLUMN

A default axis for column indices in a grid coverage. Increasing values go toward positive column number. The abbreviation is lower case "i".

ROW

public static final DefaultCoordinateSystemAxis ROW

A default axis for row indices in a grid coverage. Increasing values go toward positive row number. The abbreviation is lower case "j".

DISPLAY_X

public static final DefaultCoordinateSystemAxis DISPLAY_X

A default axis for x values in a display device. Increasing values go toward display right. The abbreviation is lower case "x".

Since:

2.2

DISPLAY_Y

public static final DefaultCoordinateSystemAxis DISPLAY_Y

A default axis for y values in a display device. Increasing values go toward display down. The abbreviation is lower case "y".

Since:

2.2

Constructor Detail

DefaultCoordinateSystemAxis

public DefaultCoordinateSystemAxis(org.opengis.referencing.cs.CoordinateSystemAxis axis)

Constructs a new coordinate system axis with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.

Since:

2.2

DefaultCoordinateSystemAxis

public DefaultCoordinateSystemAxis(java.util.Map properties,
                                   java.lang.String abbreviation,
                                   org.opengis.referencing.cs.AxisDirection direction,
                                   javax.units.Unit unit)

Constructs an axis from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

abbreviation - The abbreviation used for this coordinate system axes.

direction - The direction of this coordinate system axis.

unit - The unit of measure used for this coordinate system axis.

DefaultCoordinateSystemAxis

public DefaultCoordinateSystemAxis(java.lang.String abbreviation,
                                   org.opengis.referencing.cs.AxisDirection direction,
                                   javax.units.Unit unit)

Constructs an axis with the same name as the abbreviation.

Parameters:

abbreviation - The abbreviation used for this coordinate system axes.

direction - The direction of this coordinate system axis.

unit - The unit of measure used for this coordinate system axis.

DefaultCoordinateSystemAxis

public DefaultCoordinateSystemAxis(org.opengis.util.InternationalString name,
                                   java.lang.String abbreviation,
                                   org.opengis.referencing.cs.AxisDirection direction,
                                   javax.units.Unit unit)

Constructs an axis with a name as an international string and an abbreviation. The name of this identified object is set to the unlocalized version of the argument, as given by name.toString(null). The same argument is also stored as an alias, which allows fetching localized versions of the name.

Parameters:

name - The name of this axis. Also stored as an alias for localization purpose.

abbreviation - The abbreviation used for this coordinate system axis.

direction - The direction of this coordinate system axis.

unit - The unit of measure used for this coordinate system axis.

Method Detail

getDirection

public static org.opengis.referencing.cs.AxisDirection getDirection(java.lang.String direction)
                                                             throws java.util.NoSuchElementException

Returns an axis direction constants from its name.

Parameters:

direction - The direction name (e.g. "north", "east", etc.).

Returns:

The axis direction for the given name/.

Throws:

java.util.NoSuchElementException - if the given name is not a know axis direction.

getAbbreviation

public java.lang.String getAbbreviation()

The abbreviation used for this coordinate system axes. This abbreviation is also used to identify the ordinates in coordinate tuple. Examples are "X" and "Y".

Specified by:

getAbbreviation in interface org.opengis.referencing.cs.CoordinateSystemAxis

Returns:

The coordinate system axis abbreviation.

getDirection

public org.opengis.referencing.cs.AxisDirection getDirection()

Direction of this coordinate system axis. In the case of Cartesian projected coordinates, this is the direction of this coordinate system axis locally. Examples: north or south, east or west, up or down.

Within any set of coordinate system axes, only one of each pair of terms can be used. For earth-fixed coordinate reference systems, this direction is often approximate and intended to provide a human interpretable meaning to the axis. When a geodetic datum is used, the precise directions of the axes may therefore vary slightly from this approximate direction.

Note that an DefaultEngineeringCRS often requires specific descriptions of the directions of its coordinate system axes.

Specified by:

getDirection in interface org.opengis.referencing.cs.CoordinateSystemAxis

getUnit

public javax.units.Unit getUnit()

The unit of measure used for this coordinate system axis. The value of this coordinate in a coordinate tuple shall be recorded using this unit of measure, whenever those coordinates use a coordinate reference system that uses a coordinate system that uses this axis.

Specified by:

getUnit in interface org.opengis.referencing.cs.CoordinateSystemAxis

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compares the specified object with this axis for equality.

Overrides:

equals in class AbstractIdentifiedObject

Parameters:

object - The object to compare to .

compareMetadata - for performing a strict comparaison, or for comparing only properties relevant to transformations.

Returns:

if both objects are equal.

hashCode

public int hashCode()

Returns a hash value for this axis. This value doesn't need to be the same in past or future versions of this class.

Overrides:

hashCode in class AbstractIdentifiedObject

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.

formatWKT

protected java.lang.String formatWKT(Formatter formatter)

Format the inner part of a Well Known Text (WKT) element. WKT is returned by the toString method and looks like AXIS["name",NORTH].

Overrides:

formatWKT in class Formattable

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name, which is "AXIS".

See Also:

Formattable.toWKT(), Formattable.toString()