Package org.apache.sis.referencing.datum
Class DefaultParametricDatum
java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.datum.AbstractDatum
org.apache.sis.referencing.datum.DefaultParametricDatum
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.datum.Datum
,org.opengis.referencing.IdentifiedObject
Defines the origin of a parametric coordinate reference system.
Creating new parametric datum instances
New instances can be created either directly by specifying all information to a factory method (choices 2 and 3 below), or indirectly by specifying the identifier of an entry in a database (choices 1 below).- Create a
ParametricDatum
from an identifier in a database by invokingDatumAuthorityFactory.createParametricDatum(String)
. - Create a
ParametricDatum
by invoking theDatumFactory.createParametricDatum(…)
method, (implemented for example byGeodeticObjectFactory
). - Create a
DefaultParametricDatum
by invoking the constructor.
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.7
- Version:
- 0.7
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.referencing.datum.AbstractDatum
AbstractDatum.Simplifier
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface org.opengis.referencing.datum.Datum
ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructs a new datum in which every attributes are set to a null value.DefaultParametricDatum
(Map<String, ?> properties) Creates a parametric datum from the given properties.protected
Creates a new datum with the same values than the specified one. -
Method Summary
Methods inherited from class org.apache.sis.referencing.datum.AbstractDatum
castOrCopy, computeHashCode, equals, getAnchorPoint, getDomainOfValidity, getInterface, getRealizationEpoch, getScope, isHeuristicMatchForName
Methods inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toString, toWKT
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
-
Constructor Details
-
DefaultParametricDatum
Creates a parametric 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" Identifier
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" Identifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"anchorPoint" InternationalString
orString
AbstractDatum.getAnchorPoint()
"realizationEpoch" Date
AbstractDatum.getRealizationEpoch()
"domainOfValidity" Extent
AbstractDatum.getDomainOfValidity()
"scope" InternationalString
orString
AbstractDatum.getScope()
- Parameters:
properties
- the properties to be given to the identified object.- See Also:
-
DefaultParametricDatum
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.
Warning: in a future SIS version, the parameter type may be changed toorg.opengis.referencing.datum.ParametricDatum
. This change is pending GeoAPI revision.- Parameters:
datum
- the datum to copy.
-
DefaultParametricDatum
private DefaultParametricDatum()Constructs a new datum in which every attributes are set to a null value. This is not a valid object. This constructor is strictly reserved to JAXB, which will assign values to the fields using reflection.
-
-
Method Details
-
formatTo
Formats this datum as a Well Known TextParametricDatum[…]
element.Compatibility note:ParametricDatum
is defined in the WKT 2 specification only.- Overrides:
formatTo
in classAbstractDatum
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"ParametricDatum"
.- See Also:
-