Package org.apache.sis.referencing.crs
Class DefaultVerticalCRS
java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.AbstractReferenceSystem
org.apache.sis.referencing.crs.AbstractCRS
org.apache.sis.referencing.crs.DefaultVerticalCRS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.crs.CoordinateReferenceSystem
,org.opengis.referencing.crs.SingleCRS
,org.opengis.referencing.crs.VerticalCRS
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
public class DefaultVerticalCRS
extends AbstractCRS
implements org.opengis.referencing.crs.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
- Version:
- 0.7
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.referencing.datum.VerticalDatum
The datum.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Fields inherited from interface org.opengis.referencing.ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructs a new object in which every attributes are set to a null value.DefaultVerticalCRS
(Map<String, ?> properties, org.opengis.referencing.datum.VerticalDatum datum, org.opengis.referencing.cs.VerticalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protected
DefaultVerticalCRS
(org.opengis.referencing.crs.VerticalCRS crs) Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultVerticalCRS
castOrCopy
(org.opengis.referencing.crs.VerticalCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.(package private) final AbstractCRS
createSameType
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.forConvention
(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected String
Formats this CRS as a Well Known TextVerticalCRS[…]
element.org.opengis.referencing.cs.VerticalCS
Returns the coordinate system.org.opengis.referencing.datum.VerticalDatum
getDatum()
Returns the datum.Class
<? extends org.opengis.referencing.crs.VerticalCRS> Returns the GeoAPI interface implemented by this class.private void
setCoordinateSystem
(org.opengis.referencing.cs.VerticalCS cs) Used by JAXB only (invoked by reflection).private void
setDatum
(org.opengis.referencing.datum.VerticalDatum value) Invoked by JAXB at unmarshalling time.Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, computeHashCode, equals, formatCS, getCached, getCoordinateSystem, isBaseCRS, setCached, setCoordinateSystem
Methods inherited from class org.apache.sis.referencing.AbstractReferenceSystem
getDomainOfValidity, getScope
Methods inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toString, toWKT
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface org.opengis.referencing.ReferenceSystem
getDomainOfValidity, getScope
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
datum
private org.opengis.referencing.datum.VerticalDatum datumThe datum.Consider this field as final! This field is modified only at unmarshalling time by
setDatum(VerticalDatum)
- See Also:
-
-
Constructor Details
-
DefaultVerticalCRS
public DefaultVerticalCRS(Map<String, ?> properties, org.opengis.referencing.datum.VerticalDatum datum, org.opengis.referencing.cs.VerticalCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than 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
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system.- See Also:
-
DefaultVerticalCRS
protected DefaultVerticalCRS(org.opengis.referencing.crs.VerticalCRS crs) Constructs a new coordinate reference 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:
crs
- the coordinate reference system to copy.- See Also:
-
DefaultVerticalCRS
private DefaultVerticalCRS()Constructs a new object in which every attributes are set to a null value. This is not a valid object. This constructor is strictly reserved to JAXB, which will assign values to the fields using reflection.
-
-
Method Details
-
castOrCopy
Returns a SIS coordinate reference 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, ornull
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
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsVerticalCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineVerticalCRS
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classAbstractCRS
- Returns:
VerticalCRS.class
or a user-defined sub-interface.
-
getDatum
public org.opengis.referencing.datum.VerticalDatum getDatum()Returns the datum.- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.SingleCRS
- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.VerticalCRS
- Overrides:
getDatum
in classAbstractCRS
- Returns:
- the datum.
-
getCoordinateSystem
public org.opengis.referencing.cs.VerticalCS getCoordinateSystem()Returns the coordinate system.- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.CoordinateReferenceSystem
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.SingleCRS
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.VerticalCRS
- Overrides:
getCoordinateSystem
in classAbstractCRS
- Returns:
- the coordinate system.
-
forConvention
Returns a coordinate reference system 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 returnsthis
.- Overrides:
forConvention
in classAbstractCRS
- 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:
-
createSameType
final AbstractCRS createSameType(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.- Overrides:
createSameType
in classAbstractCRS
-
formatTo
Formats this CRS as a Well Known TextVerticalCRS[…]
element.- Overrides:
formatTo
in classAbstractCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"VerticalCRS"
(WKT 2) or"Vert_CS"
(WKT 1).- See Also:
-
setDatum
private void setDatum(org.opengis.referencing.datum.VerticalDatum value) Invoked by JAXB at unmarshalling time.- See Also:
-
setCoordinateSystem
private void setCoordinateSystem(org.opengis.referencing.cs.VerticalCS cs) Used by JAXB only (invoked by reflection).- See Also:
-