Module org.apache.sis.referencing

Package org.apache.sis.referencing.datum

Class DefaultEngineeringDatum

Object

FormattableObject

AbstractIdentifiedObject

AbstractDatum

DefaultEngineeringDatum

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Datum, Engineering­Datum, Identified­Object

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

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.

Since:

0.4

See Also:

• Default­Engineering­CRS
• Geodetic­Authority­Factory.create­Engineering­Datum(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

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

Modifier	Constructor	Description
	Default­Engineering­Datum(Map<String,?> properties)	Creates an engineering datum from the given properties.
protected	Default­Engineering­Datum(Engineering­Datum datum)	Creates a new datum with the same values than the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Engineering­Datum	cast­Or­Copy(Engineering­Datum object)	Returns a SIS datum implementation with the same values than the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats this datum as a Well Known Text Engineering­Datum[…] element.
Class<? extends Engineering­Datum>	get­Interface()	Returns the GeoAPI interface implemented by this class.

Methods inherited from class AbstractDatum

cast­Or­Copy, equals, get­Anchor­Point, get­Domain­Of­Validity, get­Realization­Epoch, get­Scope, is­Heuristic­Match­For­Name

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface Datum

get­Anchor­Point, get­Domain­Of­Validity, get­Realization­Epoch, get­Scope

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Constructor Details

DefaultEngineeringDatum

public DefaultEngineeringDatum(Map<String,?> properties)

Creates an engineering datum from the given properties. The properties map is given unchanged to the super-class constructor. The following table is a reminder of main (not all) properties:

Recognized properties (non exhaustive list)

Property name	Value type	Returned by
"name"	ReferenceIdentifier or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()
"anchorPoint"	InternationalString or String	AbstractDatum.getAnchorPoint()
"realizationEpoch"	Date	AbstractDatum.getRealizationEpoch()

Parameters:

properties - the properties to be given to the identified object.

See Also:

• Geodetic­Object­Factory.create­Engineering­Datum(Map)

DefaultEngineeringDatum

protected DefaultEngineeringDatum(EngineeringDatum datum)

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

See Also:

• cast­Or­Copy(Engineering­Datum)

Method Details

castOrCopy

public static DefaultEngineeringDatum castOrCopy(EngineeringDatum object)

Returns a SIS 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 SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

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

getInterface

public Class<? extends EngineeringDatum> getInterface()

Returns the GeoAPI interface implemented by this class. The SIS implementation returns Engineering­Datum.class.

Note for implementers

Subclasses usually do not need to override this method since GeoAPI does not define Engineering­Datum sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.

Overrides:

get­Interface in class Abstract­Datum

Returns:

Engineering­Datum.class or a user-defined sub-interface.

formatTo

protected String formatTo(Formatter formatter)

Formats this datum as a Well Known Text Engineering­Datum[…] element.

Overrides:

format­To in class Abstract­Datum

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Engineering­Datum" (WKT 2) or "Local_Datum" (WKT 1).

See Also:

• WKT 2 specification §11.2