org.geotools.cs
Class DatumType

java.lang.Object
  javax.media.jai.EnumeratedParameter
      org.geotools.cs.DatumType

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DatumType.Horizontal, DatumType.Local, DatumType.Temporal, DatumType.Vertical

Deprecated. Replaced by VerticalDatumType for the vertical case. No replacement for other cases.

public abstract class DatumType

extends javax.media.jai.EnumeratedParameter

Type of the datum expressed as an enumerated value. The enumeration is split into ranges which indicate the datum's type. The value should be one of the predefined values, or within the range for local types. This will allow the OpenGIS Consortium to coordinate the addition of new interoperable codes.

Version:

$Id: DatumType.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

OpenGIS (www.opengis.org), Martin Desruisseaux

See Also:

CS_DatumType, Serialized Form

Nested Class Summary

static class	DatumType.Horizontal Deprecated. No replacement.
static class	DatumType.Local Deprecated. No replacement.
static class	DatumType.Temporal Deprecated. No replacement.
static class	DatumType.Vertical Deprecated. Replaced by VerticalDatumType

Field Summary

static DatumType.Vertical	ALTITUDE_BAROMETRIC Deprecated. Replaced by VerticalDatumType.BAROMETRIC.
static DatumType.Horizontal	CLASSIC Deprecated. No replacement, since this is a horizontal datum type.
static DatumType.Vertical	DEPTH Deprecated. Replaced by VerticalDatumType.DEPTH.
static DatumType.Vertical	ELLIPSOIDAL Deprecated. Replaced by VerticalDatumType.ELLIPSOIDAL.
static DatumType.Horizontal	GEOCENTRIC Deprecated. No replacement, since this is a horizontal datum type.
static DatumType.Vertical	GEOID_MODEL_DERIVED Deprecated. Replaced by VerticalDatumType.GEOIDAL.
static DatumType.Temporal	GMT Deprecated. A temporal datum for Greenwich Mean Time (GMT).
static DatumType.Vertical	NORMAL Deprecated. A normal height system.
static DatumType.Vertical	ORTHOMETRIC Deprecated. Replaced by VerticalDatumType.ORTHOMETRIC.
static DatumType.Local	UNKNOW Deprecated. A local datum for unknow coordinate system.
static DatumType.Temporal	UTC Deprecated. A temporal datum for Universal Time (UTC).

Method Summary

boolean	equals(java.lang.Object obj) Deprecated. Compare this DatumType with the specified object for equality.
static DatumType	getEnum(int value) Deprecated. Returns the enum for the specified value.
static DatumType	getEnum(java.lang.String name) Deprecated. Returns the enum for the specified name.
static DatumType	getEnum(java.lang.String name, java.util.Locale locale) Deprecated. Returns the enum for the specified localized name.
java.lang.String	getName(java.util.Locale locale) Deprecated. Returns this enum's name in the specified locale.
java.lang.String	getType(java.util.Locale locale) Deprecated. Returns the type name in the specified locale.
int	hashCode() Deprecated. Returns the enum value as a hash code.

Methods inherited from class javax.media.jai.EnumeratedParameter

getName, getValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASSIC

public static final DatumType.Horizontal CLASSIC

Deprecated. No replacement, since this is a horizontal datum type.

These datums, such as ED50, NAD27 and NAD83, have been designed to support horizontal positions on the ellipsoid as opposed to positions in 3-D space. These datums were designed mainly to support a horizontal component of a position in a domain of limited extent, such as a country, a region or a continent.

See Also:

CS_DatumType.CS_HD_Classic

GEOCENTRIC

public static final DatumType.Horizontal GEOCENTRIC

Deprecated. No replacement, since this is a horizontal datum type.

A geocentric datum is a "satellite age" modern geodetic datum mainly of global extent, such as WGS84 (used in GPS), PZ90 (used in GLONASS) and ITRF. These datums were designed to support both a horizontal component of position and a vertical component of position (through ellipsoidal heights). The regional realizations of ITRF, such as ETRF, are also included in this category.

See Also:

CS_DatumType.CS_HD_Geocentric

ORTHOMETRIC

public static final DatumType.Vertical ORTHOMETRIC

Deprecated. Replaced by VerticalDatumType.ORTHOMETRIC.

A vertical datum for orthometric heights that are measured along the plumb line.

See Also:

CS_DatumType.CS_VD_Orthometric

ELLIPSOIDAL

public static final DatumType.Vertical ELLIPSOIDAL

Deprecated. Replaced by VerticalDatumType.ELLIPSOIDAL.

A vertical datum for ellipsoidal heights that are measured along the normal to the ellipsoid used in the definition of horizontal datum.

See Also:

CS_DatumType.CS_VD_Ellipsoidal

ALTITUDE_BAROMETRIC

public static final DatumType.Vertical ALTITUDE_BAROMETRIC

Deprecated. Replaced by VerticalDatumType.BAROMETRIC.

The vertical datum of altitudes or heights in the atmosphere. These are approximations of orthometric heights obtained with the help of a barometer or a barometric altimeter. These values are usually expressed in one of the following units: meters, feet, millibars (used to measure pressure levels), or theta value (units used to measure geopotential height).

See Also:

CS_DatumType.CS_VD_AltitudeBarometric

NORMAL

public static final DatumType.Vertical NORMAL

Deprecated.

A normal height system.

See Also:

CS_DatumType.CS_VD_Normal

GEOID_MODEL_DERIVED

public static final DatumType.Vertical GEOID_MODEL_DERIVED

Deprecated. Replaced by VerticalDatumType.GEOIDAL.

A vertical datum of geoid model derived heights, also called GPS-derived heights. These heights are approximations of orthometric heights (H), constructed from the ellipsoidal heights (h) by the use of the given geoid undulation model (N) through the equation: H=h-N.

See Also:

CS_DatumType.CS_VD_GeoidModelDerived

DEPTH

public static final DatumType.Vertical DEPTH

Deprecated. Replaced by VerticalDatumType.DEPTH.

This attribute is used to support the set of datums generated for hydrographic engineering projects where depth measurements below sea level are needed. It is often called a hydrographic or a marine datum. Depths are measured in the direction perpendicular (approximately) to the actual equipotential surfaces of the earth's gravity field, using such procedures as echo-sounding.

See Also:

CS_DatumType.CS_VD_Depth

UTC

public static final DatumType.Temporal UTC

Deprecated.

A temporal datum for Universal Time (UTC). UTC is based on an atomic clock, while GMT is based on astronomical observations.

Note: This enum is not part of OpenGIS specification. It may change in an incompatible way if OpenGIS define an equivalent enum.

GMT

public static final DatumType.Temporal GMT

Deprecated.

A temporal datum for Greenwich Mean Time (GMT). GMT is based on astronomical observations, while UTC is based on an atomic clock.

Note: This enum is not part of OpenGIS specification. It may change in an incompatible way if OpenGIS define an equivalent enum.

UNKNOW

public static final DatumType.Local UNKNOW

Deprecated.

A local datum for unknow coordinate system. Such coordinate system are usually assumed cartesian, but will not have any transformation path to other CS.

Note: This enum is not part of OpenGIS specification. It may change in an incompatible way if OpenGIS define an equivalent enum.

See Also:

LocalDatum.UNKNOW, LocalCoordinateSystem.CARTESIAN, LocalCoordinateSystem.PROMISCUOUS

Method Detail

getEnum

public static DatumType getEnum(int value)

Deprecated.

Returns the enum for the specified value.

Parameters:

value - The enum value.

Returns:

The enum for the specified value.

getEnum

public static DatumType getEnum(java.lang.String name)

Deprecated.

Returns the enum for the specified name. Search is case and locale insensitive.

Parameters:

name - One of the constant values (GEOCENTRIC, ELLIPSOIDAL, etc.)

Returns:

The enum for the specified name.

Throws:

java.util.NoSuchElementException - if there is no enum for the specified name.

getEnum

public static DatumType getEnum(java.lang.String name,
                                java.util.Locale locale)

Deprecated.

Returns the enum for the specified localized name. Search is case-insensitive.

Parameters:

name - The localized name (e.g. "G?ocentrique", "Ellipso?dal", etc.)

locale - The locale, or null for the default locale.

Returns:

The enum for the specified localized name.

Throws:

java.util.NoSuchElementException - if there is no enum for the specified name.

getType

public java.lang.String getType(java.util.Locale locale)

Deprecated.

Returns the type name in the specified locale. Type may be "Horizontal", "Vertical", "Temporal" or "Local".

getName

public java.lang.String getName(java.util.Locale locale)

Deprecated.

Returns this enum's name in the specified locale. If no name is available for the specified locale, a default one will be used.

Parameters:

locale - The locale, or null for the default locale.

Returns:

Enum's name in the specified locale.

hashCode

public int hashCode()

Deprecated.

Returns the enum value as a hash code.

Returns:

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

equals

public boolean equals(java.lang.Object obj)

Deprecated.

Compare this DatumType with the specified object for equality. Two datum types are equals if, and only if, they are of the same class and have the same enum value.