org.geotoolkit.referencing.datum
Class DefaultEngineeringDatum

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractDatum
              DefaultEngineeringDatum

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, Datum, EngineeringDatum, IdentifiedObject

@Immutable
public class DefaultEngineeringDatum
extends AbstractDatum
implements EngineeringDatum

Defines the origin of an engineering coordinate reference system. An engineering datum is used in a region around that origin. This origin can be fixed with respect to the earth (such as a defined point at a construction site), or be a defined point on a moving vehicle (such as on a ship or satellite).

Since:

1.2

Version:

3.18

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static DefaultEngineeringDatum

UNKNOWN An engineering datum for unknown coordinate reference system.

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultEngineeringDatum(EngineeringDatum datum)
Constructs a new datum with the same values than the specified one.

DefaultEngineeringDatum(Map<String,?> properties)
Constructs an engineering datum from a set of properties.

DefaultEngineeringDatum(String name)
Constructs an engineering datum from a name.

Method Summary

boolean	equals(Object object, ComparisonMode mode) Compare this datum with the specified object for equality.
String	formatWKT(Formatter formatter) Formats the inner part of a Well Known Text (WKT) element.
static DefaultEngineeringDatum	wrap(EngineeringDatum object) Returns a Geotk datum implementation with the same values than the given arbitrary implementation.

Methods inherited from class AbstractDatum

getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope

Methods inherited from class AbstractIdentifiedObject

computeHashCode, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, hashCode, nameMatches, nameMatches, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface Datum

getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

UNKNOWN

public static final DefaultEngineeringDatum UNKNOWN

An engineering datum for unknown coordinate reference system. Such CRS are usually assumed Cartesian, but will not have any transformation path to other CRS.

See Also:

DefaultEngineeringCRS.CARTESIAN_2D, DefaultEngineeringCRS.CARTESIAN_3D

Constructor Detail

DefaultEngineeringDatum

public DefaultEngineeringDatum(EngineeringDatum datum)

Constructs a new datum with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotk 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.

Parameters:

datum - The datum to copy.

Since:

2.2

DefaultEngineeringDatum

public DefaultEngineeringDatum(String name)

Constructs an engineering datum from a name.

Parameters:

name - The datum name.

DefaultEngineeringDatum

public DefaultEngineeringDatum(Map<String,?> properties)

Constructs an engineering datum 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".

Method Detail

wrap

public static DefaultEngineeringDatum wrap(EngineeringDatum object)

Returns a Geotk datum implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object.

Parameters:

object - The object to wrap in a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

equals

public boolean equals(Object object,
                      ComparisonMode mode)

Compare this datum with the specified object for equality.

Specified by:

equals in interface LenientComparable

Overrides:

equals in class AbstractDatum

Parameters:

object - The object to compare to this.

mode - STRICT for performing a strict comparison, or IGNORE_METADATA for comparing only properties relevant to transformations.

Returns:

true if both objects are equal.

formatWKT

public String formatWKT(Formatter formatter)

Formats the inner part of a Well Known Text (WKT) element.

Specified by:

formatWKT in interface Formattable

Overrides:

formatWKT in class AbstractDatum

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name, which is "LOCAL_DATUM".

See Also:

FormattableObject.toWKT(), FormattableObject.toString()