org.geotools.referencing.crs
Class DefaultVerticalCRS

java.lang.Object
  org.geotools.referencing.wkt.Formattable
      org.geotools.referencing.AbstractIdentifiedObject
          org.geotools.referencing.AbstractReferenceSystem
              org.geotools.referencing.crs.AbstractCRS
                  org.geotools.referencing.crs.AbstractSingleCRS
                      org.geotools.referencing.crs.DefaultVerticalCRS

All Implemented Interfaces:

org.opengis.referencing.crs.CoordinateReferenceSystem, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem, java.io.Serializable, org.opengis.referencing.crs.SingleCRS, org.opengis.referencing.crs.VerticalCRS

public class DefaultVerticalCRS

extends AbstractSingleCRS

implements org.opengis.referencing.crs.VerticalCRS

A 1D coordinate reference system used for recording heights or depths. Vertical CRSs make use of the direction of gravity to define the concept of height or depth, but the relationship with gravity may not be straightforward. By implication, ellipsoidal heights (h) cannot be captured in a vertical coordinate reference system. Ellipsoidal heights cannot exist independently, but only as inseparable part of a 3D coordinate tuple defined in a geographic 3D coordinate reference system.

Used with CS type(s)

Vertical

Since:

2.1

Version:

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

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

static DefaultVerticalCRS

ELLIPSOIDAL_HEIGHT Default vertical coordinate reference system using ellipsoidal datum.

Fields inherited from class org.geotools.referencing.crs.AbstractSingleCRS

datum

Fields inherited from class org.geotools.referencing.crs.AbstractCRS

coordinateSystem

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.ReferenceSystem

SCOPE_KEY, VALID_AREA_KEY

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultVerticalCRS(java.util.Map properties, org.opengis.referencing.datum.VerticalDatum datum, org.opengis.referencing.cs.VerticalCS cs)
Constructs a vertical CRS from a set of properties.

DefaultVerticalCRS(java.lang.String name, org.opengis.referencing.datum.VerticalDatum datum, org.opengis.referencing.cs.VerticalCS cs)
Constructs a vertical CRS from a name.

DefaultVerticalCRS(org.opengis.referencing.crs.VerticalCRS crs)
Constructs a new vertical CRS with the same values than the specified one.

Method Summary

protected java.lang.String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.
int	hashCode() Returns a hash value for this geographic CRS.

Methods inherited from class org.geotools.referencing.crs.AbstractSingleCRS

equals, getAxis, getDatum, getDimension

Methods inherited from class org.geotools.referencing.crs.AbstractCRS

distance, getCoordinateSystem

Methods inherited from class org.geotools.referencing.AbstractReferenceSystem

getScope, getValidArea

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.crs.SingleCRS

getCoordinateSystem, getDatum

Methods inherited from interface org.opengis.referencing.ReferenceSystem

getScope, getValidArea

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

ELLIPSOIDAL_HEIGHT

public static final DefaultVerticalCRS ELLIPSOIDAL_HEIGHT

Default vertical coordinate reference system using ellipsoidal datum. Ellipsoidal heights are measured along the normal to the ellipsoid used in the definition of horizontal datum.

Constructor Detail

DefaultVerticalCRS

public DefaultVerticalCRS(org.opengis.referencing.crs.VerticalCRS crs)

Constructs a new vertical CRS 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

DefaultVerticalCRS

public DefaultVerticalCRS(java.lang.String name,
                          org.opengis.referencing.datum.VerticalDatum datum,
                          org.opengis.referencing.cs.VerticalCS cs)

Constructs a vertical CRS from a name.

Parameters:

name - The name.

datum - The datum.

cs - The coordinate system.

DefaultVerticalCRS

public DefaultVerticalCRS(java.util.Map properties,
                          org.opengis.referencing.datum.VerticalDatum datum,
                          org.opengis.referencing.cs.VerticalCS cs)

Constructs a vertical CRS from a set of properties. The properties are given unchanged to the super-class constructor.

Parameters:

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

datum - The datum.

cs - The coordinate system.

Method Detail

hashCode

public int hashCode()

Returns a hash value for this geographic CRS.

Overrides:

hashCode in class AbstractSingleCRS

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.

Overrides:

formatWKT in class AbstractSingleCRS

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name, which is "VERT_CS"