Package org.apache.sis.referencing.cs
Class DefaultVerticalCS
Object
FormattableObject
AbstractIdentifiedObject
AbstractCS
DefaultVerticalCS
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- CoordinateSystem,- VerticalCS,- IdentifiedObject
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.
| 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 theCoordinateSystemAxis 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:
Defined in the sis-referencing module
- 
Field SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, LOCALE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultVerticalCS(Map<String, ?> properties, CoordinateSystemAxis axis) Constructs a coordinate system from a set of properties.protectedCreates a new coordinate system with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultVerticalCScastOrCopy(VerticalCS object) Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.forConvention(AxesConvention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.Class<? extends VerticalCS>Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractCScastOrCopy, computeHashCode, equals, formatTo, getAxis, getDimensionMethods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface CoordinateSystemgetAxis, getDimensionMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKT
- 
Constructor Details- 
DefaultVerticalCSConstructs 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" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()- Parameters:
- properties- the properties to be given to the identified object.
- axis- the single axis (e.g. “height” or “depth”).
- See Also:
 
- 
DefaultVerticalCSCreates 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:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS coordinate system implementation with the same values than the given arbitrary implementation. If the given object isnull, then this method returnsnull. 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returnsVerticalCS.class.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineVerticalCSsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
- getInterfacein class- AbstractCS
- Returns:
- VerticalCS.classor a user-defined sub-interface.
 
- 
forConventionReturns 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 returnsthis.- Overrides:
- forConventionin class- AbstractCS
- 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:
 
 
-