Class DefaultVerticalCS

Object

FormattableObject

AbstractIdentifiedObject

AbstractCS

DefaultVerticalCS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Coordinate­System, Vertical­CS, Identified­Object

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 with 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

Field Summary

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 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­CS(Map<String,?> properties, Coordinate­System­Axis axis)	Constructs a coordinate system from a set of properties.
protected	Default­Vertical­CS(Vertical­CS original)	Creates a new coordinate system with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Vertical­CS	cast­Or­Copy(Vertical­CS object)	Returns a SIS coordinate system implementation with the same values as the given arbitrary implementation.
Default­Vertical­CS	for­Convention(Axes­Convention convention)	Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.
Class<? extends Vertical­CS>	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.

Methods inherited from class AbstractCS

cast­Or­Copy, format­To, get­Axis, get­Dimension, has­Same­Axes

Modifier and Type	Method	Description
static Abstract­CS	cast­Or­Copy(Coordinate­System object)	Returns a SIS coordinate system implementation with the values of the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats the inner part of the Well Known Text (WKT) representation of this coordinate system.
final Coordinate­System­Axis	get­Axis(int dimension)	Returns the axis for this coordinate system at the specified dimension.
final int	get­Dimension()	Returns the number of dimensions of this coordinate system.
final boolean	has­Same­Axes(Coordinate­System other)	Returns whether this coordinate system has the same axes as the specified CS, ignoring axis order.

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

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

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

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

original - the coordinate system to copy.

See Also:

• cast­Or­Copy(Vertical­CS)

Method Details

castOrCopy

public static DefaultVerticalCS castOrCopy(VerticalCS object)

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

getStandardType

public Class<? extends VerticalCS> 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­CS

Returns:

Vertical­CS.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)

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)