Class DefaultCompoundCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultCompoundCRS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,Printable
,CompoundCRS
,CoordinateReferenceSystem
,IdentifiedObject
,ReferenceSystem
A CRS describing the position of points through two or more independent coordinate reference systems.
This class is often used for defining 4-dimensional (x,y,z,t)
coordinate reference systems as an aggregation of simpler CRS. Below is two examples of such aggregations:
Strictly speaking, only the flat list on the left side is allowed by OGC/ISO specifications.
However, Apache SIS relaxes this rule by allowing hierarchies as shown on the right side.
This flexibility allows SIS to preserve information about the (x,y,z) part
(e.g. the EPSG identifier) that would otherwise been lost. Users can obtain the list of their choice
by invoking
Flat list
CompoundCRS
— (x, y, z, t)
├─ProjectedCRS
— (x, y)
├─VerticalCRS
— (z)
└─TemporalCRS
— (t)
Hierarchical structure
CompoundCRS
— (x, y, z, t)
├─CompoundCRS
— (x, y, z)
│ ├─ProjectedCRS
— (x, y)
│ └─VerticalCRS
— (z)
└─TemporalCRS
— (t)
getSingleComponents()
or getComponents()
respectively.
Component order
Apache SIS is flexible about the order of components. However, the following order is recommended:- Horizontal CRS (e.g., two-dimensional
GeographicCRS
,ProjectedCRS
orEngineeringCRS
). - Optionally followed by a
VerticalCRS
or aParametricCRS
(but not both). - Optionally followed by a
TemporalCRS
.
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself) and allCoordinateReferenceSystem
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:
-
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
ConstructorsModifierConstructorDescriptionDefaultCompoundCRS
(Map<String, ?> properties, CoordinateReferenceSystem... components) Constructs a compound CRS from the given properties and CRS.protected
Constructs a new coordinate reference system with the same values as the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultCompoundCRS
castOrCopy
(CompoundCRS object) Returns a SIS CRS implementation with the same values as the given arbitrary implementation.forConvention
(AxesConvention convention) Returns a compound CRS equivalent to this one but with axes rearranged according the given convention.protected String
Formats this CRS as a Well Known TextCompoundCRS[…]
element.Returns the ordered list of coordinate reference systems.Class
<? extends CompoundCRS> Returns the GeoAPI interface implemented by this class.Returns the ordered list of single coordinate reference systems.Methods inherited from class AbstractCRS
castOrCopy, getCoordinateSystem
Methods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScope
Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class FormattableObject
print, toString, toString, toWKT
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface CoordinateReferenceSystem
getCoordinateSystem
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface ReferenceSystem
getDomainOfValidity, getScope
-
Constructor Details
-
DefaultCompoundCRS
Constructs a compound CRS from the given properties and CRS. 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
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"domains" DefaultObjectDomain
(optionally as array)AbstractIdentifiedObject.getDomains()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
- Parameters:
properties
- the properties to be given to the coordinate reference system.components
- the sequence of coordinate reference systems making this compound CRS.- Throws:
ClassCastException
- if a CRS is neither aSingleCRS
or aCompoundCRS
.IllegalArgumentException
- if the given array does not contain at least two components, or if two consecutive components are a geographic CRS with an ellipsoidal height.- See Also:
-
DefaultCompoundCRS
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.- Throws:
ClassCastException
- if a CRS is neither aSingleCRS
or aCompoundCRS
.
-
-
Method Details
-
castOrCopy
Returns a SIS CRS implementation with the same values as 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 returnsCompoundCRS.class
.Note for implementers
Subclasses usually do not need to override this method since GeoAPI does not defineCompoundCRS
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:
CompoundCRS.class
or a user-defined sub-interface.
-
getComponents
Returns the ordered list of coordinate reference systems. This is the list of CRS given at construction time. This list may contains otherCompoundCRS
instances, as described in class Javadoc. For a flattened list ofSingleCRS
instances, seegetSingleComponents()
.- Specified by:
getComponents
in interfaceCompoundCRS
- Returns:
- the coordinate reference systems as an unmodifiable list.
-
getSingleComponents
Returns the ordered list of single coordinate reference systems. If this compound CRS contains other compound CRS, then all of them are flattened in a sequence ofSingleCRS
objects. See class Javadoc for more information.- Returns:
- the single coordinate reference systems as an unmodifiable list.
- See Also:
-
forConvention
Returns a compound CRS equivalent to this one but with axes rearranged according the given convention. This method first reorders the axes of each individual CRS component. Then, if the given convention isAxesConvention.DISPLAY_ORIENTED
orAxesConvention.NORMALIZED
, this method will also reorder the components with horizontal CRS (geodetic or projected) first, then vertical CRS, then temporal CRS.- 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:
-
formatTo
Formats this CRS as a Well Known TextCompoundCRS[…]
element.WKT validity
The WKT version 2 format restricts compound CRS to the following components in that order:- A mandatory horizontal CRS (only one of two-dimensional
GeographicCRS
orProjectedCRS
orEngineeringCRS
). - Optionally followed by a
VerticalCRS
or aParametricCRS
(but not both). - Optionally followed by a
TemporalCRS
.
- Overrides:
formatTo
in classAbstractCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"CompoundCRS"
(WKT 2) or"Compd_CS"
(WKT 1).- See Also:
- A mandatory horizontal CRS (only one of two-dimensional
-