Class DefaultVerticalCRS

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

AbstractCRS

DefaultVerticalCRS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Coordinate­Reference­System, Single­CRS, Vertical­CRS, Identified­Object, Reference­System

public class DefaultVerticalCRS
extends AbstractCRS
implements VerticalCRS

A 1-dimensional coordinate reference system used for recording heights or depths. Vertical CRSs make use of the direction of gravity to define the concept of height or depth, but the relationship with gravity may not be straightforward.

Used with datum type: Vertical.
Used with coordinate system type: Vertical.

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances 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­Vertical­Datum
• Default­Vertical­CS
• Geodetic­Authority­Factory.create­Vertical­CRS(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Vertical­CRS(Map<String,?> properties, Vertical­Datum datum, Default­Datum­Ensemble<Vertical­Datum> ensemble, Vertical­CS cs)	Creates a coordinate reference system from the given properties, datum and coordinate system.
	Default­Vertical­CRS(Map<String,?> properties, Vertical­Datum datum, Vertical­CS cs)	Deprecated, for removal: This API element is subject to removal in a future version. A Default­Datum­Ensemble argument has been added.
protected	Default­Vertical­CRS(Vertical­CRS crs)	Constructs a new coordinate reference system with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Vertical­CRS	cast­Or­Copy(Vertical­CRS object)	Returns a SIS coordinate reference system implementation with the same values as the given arbitrary implementation.
Default­Vertical­CRS	for­Convention(Axes­Convention convention)	Returns a CRS equivalent to this one but with axes rearranged according the given convention.
protected String	format­To(Formatter formatter)	Formats this CRS as a Well Known Text Vertical­CRS[…] element.
Vertical­CS	get­Coordinate­System()	Returns the coordinate system.
Vertical­Datum	get­Datum()	Returns an identification of a particular reference level surface used as a zero-height surface.
Default­Datum­Ensemble<Vertical­Datum>	get­Datum­Ensemble()	Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other.
Class<? extends Vertical­CRS>	get­Interface()	Returns the GeoAPI interface implemented by this class.

Methods inherited from class AbstractCRS

cast­Or­Copy

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Scope

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, is­Heuristic­Match­For­Name

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 IdentifiedObject

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

Methods inherited from interface ReferenceSystem

get­Domain­Of­Validity, get­Scope

Constructor Details

DefaultVerticalCRS

public DefaultVerticalCRS(Map<String,?> properties,
 VerticalDatum datum,
 DefaultDatumEnsemble<VerticalDatum> ensemble,
 VerticalCS cs)

Creates a coordinate reference system from the given properties, datum and coordinate system. At least one of the datum and ensemble arguments shall be non-null. The properties given in argument follow the same rules as for 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()

Parameters:

properties - the properties to be given to the coordinate reference system.

datum - the datum, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the coordinate system.

Since:

1.5

See Also:

• Geodetic­Object­Factory.create­Vertical­CRS(Map, Vertical­Datum, Default­Datum­Ensemble, Vertical­CS)

DefaultVerticalCRS

@Deprecated(since="1.5",
            forRemoval=true)
public DefaultVerticalCRS(Map<String,?> properties,
 VerticalDatum datum,
 VerticalCS cs)

Deprecated, for removal: This API element is subject to removal in a future version.

A Default­Datum­Ensemble argument has been added.

DefaultVerticalCRS

protected DefaultVerticalCRS(VerticalCRS crs)

Constructs a new coordinate reference system 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:

crs - the coordinate reference system to copy.

See Also:

• cast­Or­Copy(Vertical­CRS)

Method Details

castOrCopy

public static DefaultVerticalCRS castOrCopy(VerticalCRS object)

Returns a SIS coordinate reference system 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.

getInterface

public Class<? extends VerticalCRS> getInterface()

Returns the GeoAPI interface implemented by this class. The SIS implementation returns Vertical­CRS.class.

Note for implementers

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

Returns:

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

getDatum

public VerticalDatum getDatum()

Returns an identification of a particular reference level surface used as a zero-height surface. This property may be null if this CRS is related to an object identified only by a datum ensemble.

Specified by:

get­Datum in interface Single­CRS

Specified by:

get­Datum in interface Vertical­CRS

Returns:

the vertical datum, or null if this CRS is related to an object identified only by a datum ensemble.

getDatumEnsemble

public DefaultDatumEnsemble<VerticalDatum> getDatumEnsemble()

Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other. This property may be null if this CRS is related to an object identified only by a single datum.

Warning: in a future SIS version, the return type may be changed to the org.opengis.referencing.datum.Datum­Ensemble interface. This change is pending GeoAPI revision.

Returns:

the datum ensemble, or null if this CRS is related to an object identified only by a single datum.

Since:

1.5

getCoordinateSystem

public VerticalCS getCoordinateSystem()

Returns the coordinate system.

Specified by:

get­Coordinate­System in interface Coordinate­Reference­System

Specified by:

get­Coordinate­System in interface Single­CRS

Specified by:

get­Coordinate­System in interface Vertical­CRS

Overrides:

get­Coordinate­System in class Abstract­CRS

Returns:

the coordinate system.

forConvention

public DefaultVerticalCRS forConvention(AxesConvention convention)

Returns a CRS equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returns this.

Overrides:

for­Convention in class Abstract­CRS

Parameters:

convention - the axes convention for which a coordinate reference system is desired.

Returns:

a coordinate reference system compatible with the given convention (may be this).

See Also:

• Abstract­CS.for­Convention(Axes­Convention)

formatTo

protected String formatTo(Formatter formatter)

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

Overrides:

format­To in class Abstract­CRS

Parameters:

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

Returns:

"Vertical­CRS" (WKT 2) or "Vert_CS" (WKT 1).

See Also:

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