org.geotools.referencing.datum

Class DefaultEngineeringDatum

Object

Formattable

AbstractIdentifiedObject

AbstractDatum

DefaultEngineeringDatum

All Implemented Interfaces:

Serializable, Datum, EngineeringDatum, IdentifiedObject

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:

2.1

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultEngineeringDatum	UNKNOW Deprecated. Use UKNONWN instead
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 Formattable

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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
boolean	equals(AbstractIdentifiedObject object, boolean compareMetadata) Compare this datum with the specified object for equality.
protected String	formatWKT(Formatter formatter) Format the inner part of a Well Known Text (WKT) element.

Methods inherited from class AbstractDatum

getAnchorPoint, getDomainOfValidity, getRealizationEpoch, getScope, getValidArea

Methods inherited from class AbstractIdentifiedObject

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

Methods inherited from class Formattable

cleanupThreadLocals, toString, toWKT, 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

UNKNOW

public static final DefaultEngineeringDatum UNKNOW

Deprecated. Use UKNONWN instead

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

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

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

equals

public boolean equals(AbstractIdentifiedObject object,
                      boolean compareMetadata)

Compare this datum with the specified object for equality.

Overrides:

equals in class AbstractDatum

Parameters:

object - The object to compare to this.

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

Returns:

true if both objects are equal.

formatWKT

protected String formatWKT(Formatter formatter)

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

Overrides:

formatWKT in class AbstractDatum

Parameters:

formatter - The formatter to use.

Returns:

The WKT element name, which is "LOCAL_DATUM"

See Also:

Formattable.toWKT(), Formattable.toString()