Class DefaultVerticalDatum

Object

FormattableObject

AbstractIdentifiedObject

AbstractDatum

DefaultVerticalDatum

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Datum, Vertical­Datum, Identified­Object

Direct Known Subclasses:

Default­Vertical­Datum.Dynamic

public class DefaultVerticalDatum
extends AbstractDatum
implements VerticalDatum

Identifies a particular reference level surface used as a zero-height surface. There are several types of vertical datums, and each may place constraints on the coordinate system axis with which it is combined to create a vertical CRS.

Creating new vertical datum instances

New instances can be created either directly by specifying all information to a factory method (choices 3 and 4 below), or indirectly by specifying the identifier of an entry in a database (choices 1 and 2 below). Choice 1 in the following list is the easiest but most restrictive way to get a vertical datum. The other choices provide more freedom.

1. Create a Vertical­Datum from one of the static convenience shortcuts listed in Common­CRS.Vertical.datum().
2. Create a Vertical­Datum from an identifier in a database by invoking Datum­Authority­Factory.create­Vertical­Datum(String).
3. Create a Vertical­Datum by invoking the Datum­Factory.create­Vertical­Datum(…) method (implemented for example by Geodetic­Object­Factory).
4. Create a Default­Vertical­Datum by invoking the constructor.

Example: the following code gets a vertical datum for height above the geoid:

VerticalDatum datum = CommonCRS.Vertical.GEOID.datum();

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:

• Common­CRS.Vertical.datum()
• Default­Vertical­CS
• Default­Vertical­CRS
• Geodetic­Authority­Factory.create­Vertical­Datum(String)
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Default­Vertical­Datum.Dynamic	A vertical reference frame in which some of the defining parameters have time dependency.

Field Summary

Fields inherited from class AbstractDatum

ANCHOR_DEFINITION_KEY, ANCHOR_EPOCH_KEY, CONVENTIONAL_RS_KEY, PUBLICATION_DATE_KEY

Modifier and Type	Field	Description
static final String	ANCHOR_DEFINITION_KEY	Key for the "anchor­Definition" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.
static final String	ANCHOR_EPOCH_KEY	Key for the "anchor­Epoch" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.
static final String	CONVENTIONAL_RS_KEY	Key for the "conventional­RS" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.
static final String	PUBLICATION_DATE_KEY	Key for the "publication­Date" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	ANCHOR_POINT_KEY	Key for the "anchor­Point" property to be given to the datum factory create­Foo(…) methods.
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the datum factory create­Foo(…) methods.
static final String	REALIZATION_EPOCH_KEY	Key for the "realization­Epoch" property to be given to the datum factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the datum factory create­Foo(…) methods.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Vertical­Datum(Map<String,?> properties, Vertical­Datum­Type type)	Creates a vertical datum from the given properties.
protected	Default­Vertical­Datum(Vertical­Datum datum)	Creates a new datum with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Vertical­Datum	cast­Or­Copy(Vertical­Datum object)	Returns a SIS datum implementation with the same values as the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats this datum as a Well Known Text Vertical­Datum[…] element.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
Vertical­Datum­Type	get­Vertical­Datum­Type()	Returns the type of this vertical datum.

Methods inherited from class AbstractDatum

cast­Or­Copy, get­Anchor­Definition, get­Anchor­Epoch, get­Anchor­Point, get­Conventional­RS, get­Domain­Of­Validity, get­Publication­Date, get­Realization­Epoch, get­Scope, is­Heuristic­Match­For­Name

Modifier and Type	Method	Description
static Abstract­Datum	cast­Or­Copy(Datum object)	Returns a SIS datum implementation with the values of the given arbitrary implementation.
Optional<International­String>	get­Anchor­Definition()	Returns a description of the relationship used to anchor the coordinate system to the Earth or alternate object.
Optional<Temporal>	get­Anchor­Epoch()	Returns the epoch at which a static datum matches a dynamic datum from which it has been derived.
International­String	get­Anchor­Point()	Deprecated. Renamed Abstract­Datum.get­Anchor­Definition() as of ISO 19111:2019.
Optional<Identified­Object>	get­Conventional­RS()	Returns the name, identifier, alias and remarks for the reference system realized by this reference frame.
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Optional<Temporal>	get­Publication­Date()	Returns the date on which the datum definition was published.
Date	get­Realization­Epoch()	Deprecated. Since ISO 19111:2019, replaced by Abstract­Datum.get­Anchor­Epoch().
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class AbstractIdentifiedObject

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

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.

Methods inherited from class FormattableObject

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

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Constructor Details

DefaultVerticalDatum

public DefaultVerticalDatum(Map<String,?> properties,
 VerticalDatumType type)

Creates a vertical 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.getAnchorDefinition()
"anchorEpoch"	Temporal	AbstractDatum.getAnchorEpoch()

Parameters:

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

type - the type of this vertical datum.

See Also:

• Geodetic­Object­Factory.create­Vertical­Datum(Map, Vertical­Datum­Type)

DefaultVerticalDatum

protected DefaultVerticalDatum(VerticalDatum datum)

Creates a new datum with the same values as 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(Vertical­Datum)

Method Details

castOrCopy

public static DefaultVerticalDatum castOrCopy(VerticalDatum object)

Returns a SIS datum implementation with the same values as 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.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­Datum

Returns:

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

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

getVerticalDatumType

public VerticalDatumType getVerticalDatumType()

Returns the type of this vertical datum.

Historical note:

This property was defined in the ISO 19111 specification published in 2003, but removed from the revision published 2007. This property provides an information similar to the anchor definition, but in a programmatic way more suitable to coordinate transformation engines.

Specified by:

get­Vertical­Datum­Type in interface Vertical­Datum

Returns:

the type of this vertical datum.

formatTo

protected String formatTo(Formatter formatter)

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

Compatibility note

OGC 01-009 defined numerical codes for various vertical datum types, for example 2005 for geoidal height. Such codes were formatted for all Datum subtypes in WKT 1. Datum types became specified only for vertical datum in the ISO 19111:2003 standard, then removed completely in the ISO 19111:2007 standard. They were reintroduced in a different form (Realization­Method) in the ISO 19111:2019 standard.

Overrides:

format­To in class Abstract­Datum

Parameters:

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

Returns:

"VDatum" or "Vertical­Datum" (WKT 2), or "Vert_Datum" (WKT 1). May also be "Member" if this datum is inside a WKT Ensemble[…] element.

See Also:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()