org.geotools.cs
Class Datum

java.lang.Object
  org.geotools.cs.Info
      org.geotools.cs.Datum

All Implemented Interfaces:

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

Direct Known Subclasses:

HorizontalDatum, LocalDatum, TemporalDatum, VerticalDatum

Deprecated. Replaced by AbstractDatum.

public class Datum

extends Info

A set of quantities from which other quantities are calculated. It may be a textual description and/or a set of parameters describing the relationship of a coordinate system to some predefined physical locations (such as center of mass) and physical directions (such as axis of spin). It can be defined as a set of real points on the earth that have coordinates. For example, a datum can be thought of as a set of parameters defining completely the origin and orientation of a coordinate system with respect to the earth. The definition of the datum may also include the temporal behavior (such as the rate of change of the orientation of the coordinate axes).

Version:

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

Author:

OpenGIS (www.opengis.org), Martin Desruisseaux

See Also:

CS_Datum, Serialized Form

Field Summary

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Datum(java.lang.CharSequence name, DatumType type)
Deprecated. Constructs a new datum with the specified name and datum type.

Method Summary

boolean	equals(Info object, boolean compareNames) Deprecated. Compare this datum with the specified object for equality.
DatumType	getDatumType() Deprecated. Replaced by DefaultVerticalDatum.getVerticalDatumType() for the vertical case. No replacement for other cases.
int	hashCode() Deprecated. Returns a hash value for this datum.

Methods inherited from class org.geotools.cs.Info

ensureNonNull, equals, getAbbreviation, getAlias, getAlias, getAuthority, getAuthorityCode, getIdentifiers, getName, getRemarks, toString, toWKT

Methods inherited from class java.lang.Object

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

Constructor Detail

Datum

public Datum(java.lang.CharSequence name,
             DatumType type)

Deprecated.

Constructs a new datum with the specified name and datum type.

Parameters:

name - The datum name.

type - The datum type.

Method Detail

getDatumType

public DatumType getDatumType()

Deprecated. Replaced by DefaultVerticalDatum.getVerticalDatumType() for the vertical case. No replacement for other cases.

Gets the type of the datum as an enumerated code.

See Also:

CS_Datum.getDatumType()

equals

public boolean equals(Info object,
                      boolean compareNames)

Deprecated.

Compare this datum with the specified object for equality.

Overrides:

equals in class Info

Parameters:

object - The object to compare to this.

compareNames - true to comparare the name, alias, authority code, etc. as well, or false to compare only properties relevant to transformations.

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Deprecated.

Returns a hash value for this datum. Name, alias, authority code and the like are not taken in account. In other words, two datums will return the same hash value if they are equal in the sense of equals(Info, false).

Overrides:

hashCode in class Info

Returns:

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