org.apache.sis.referencing.cs

Class DefaultVerticalCS

Object

FormattableObject

AbstractIdentifiedObject

AbstractCS

DefaultVerticalCS

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, CoordinateSystem, VerticalCS, IdentifiedObject

public class DefaultVerticalCS
extends AbstractCS
implements VerticalCS

A 1-dimensional coordinate system for heights or depths of points. OGC/ISO do not provide an exact definition, since the complexity of vertical CS fall outside the scope of ISO 19111. Some examples of vertical coordinate systems are:

• Height in metres from a surface dependent on the Earth's gravity field
• Height or depth represented by an atmospheric or water pressure measurement.
• Depth represented by the time needed for an echo signal to travel.
• "Sigma-level depth" (used in oceanography) as a dimensionless quantity.

The above examples show the variety of units of measurement which can be associated to vertical positions.

Permitted associations

Used with CRS	Permitted axis names
Vertical	“Gravity-related height” or “Depth”

Immutability and thread safety

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

Defined in the sis-referencing module

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultVerticalCS(Map<String,?> properties, CoordinateSystemAxis axis) Constructs a coordinate system from a set of properties.
protected	DefaultVerticalCS(VerticalCS cs) Creates a new coordinate system with the same values than the specified one.

Method Summary

Modifier and Type	Method and Description
static DefaultVerticalCS	castOrCopy(VerticalCS object) Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.
DefaultVerticalCS	forConvention(AxesConvention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.
Class<? extends VerticalCS>	getInterface() Returns the GeoAPI interface implemented by this class.

Methods inherited from class AbstractCS

cast­Or­Copy, compute­Hash­Code, equals, format­To, get­Axis, get­Dimension

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, get­Alias, get­Description, 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 CoordinateSystem

get­Axis, get­Dimension

Methods inherited from interface IdentifiedObject

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

Constructor Detail

DefaultVerticalCS

public DefaultVerticalCS(Map<String,?> properties,
                         CoordinateSystemAxis axis)

Constructs a coordinate system from a set of 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()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

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

axis - the single axis (e.g. “height” or “depth”).

See Also:

Geodetic­Object­Factory.create­Vertical­CS(Map, Coordinate­System­Axis)

DefaultVerticalCS

protected DefaultVerticalCS(VerticalCS cs)

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

cs - the coordinate system to copy.

See Also:

cast­Or­Copy(Vertical­CS)

Method Detail

castOrCopy

public static DefaultVerticalCS castOrCopy(VerticalCS object)

Returns a SIS coordinate system 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 VerticalCS> getInterface()

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

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

Overrides:

get­Interface in class Abstract­CS

Returns:

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

forConvention

public DefaultVerticalCS forConvention(AxesConvention convention)

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

Overrides:

for­Convention in class Abstract­CS

Parameters:

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

Returns:

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

See Also:

Abstract­CRS.for­Convention(Axes­Convention)