Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultCompoundCRS
- All Implemented Interfaces:
Serializable,Formattable,Deprecable,LenientComparable,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
ISO 19162 restricts compound CRS to the following components in that order:- A mandatory horizontal CRS (only one of two-dimensional
GeographicCRSorProjectedCRSorEngineeringCRS). - Optionally followed by a
VerticalCRSor aParametricCRS(but not both). - Optionally followed by a
TemporalCRS.
- Components may appear in different order.
VerticalCRS+TemporalCRS(without horizontal component) is accepted.GeocentricCRSor three-dimensionalGeographicCRScan be combined withTemporalCRS.
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, LOCALE_KEYFields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEYFields 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.protectedConstructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultCompoundCRScastOrCopy(CompoundCRS object) Returns a SIS CRS implementation with the same values than the given arbitrary implementation.protected longInvoked byhashCode()for computing the hash code when first needed.booleanequals(Object object, ComparisonMode mode) Compares this coordinate reference system with the specified object for equality.forConvention(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected StringFormats 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, getCoordinateSystemMethods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScopeMethods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObject
print, toString, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface CoordinateReferenceSystem
getCoordinateSystemMethods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKTMethods 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 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" ReferenceIdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" ReferenceIdentifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"domains" DefaultObjectDomain(optionally as array)AbstractIdentifiedObject.getDomains()"remarks" InternationalStringorStringAbstractIdentifiedObject.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:
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 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.
-
-
Method Details
-
castOrCopy
Returns a SIS CRS 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, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif 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 defineCompoundCRSsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterfacein classAbstractCRS- Returns:
CompoundCRS.classor 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 otherCompoundCRSinstances, as described in class Javadoc. For a flattened list ofSingleCRSinstances, seegetSingleComponents().- Specified by:
getComponentsin 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 ofSingleCRSobjects. See class Javadoc for more information.- Returns:
- the single coordinate reference systems as an unmodifiable list.
- See Also:
-
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.If the given convention is
AxesConvention.DISPLAY_ORIENTEDorAxesConvention.NORMALIZED, then this method will also reorder the components with horizontal CRS (geodetic or projected) first, then vertical CRS, then temporal CRS.- Overrides:
forConventionin 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:
-
equals
Compares this coordinate reference system with the specified object for equality.- Specified by:
equalsin interfaceLenientComparable- Overrides:
equalsin classAbstractCRS- Parameters:
object- the object to compare tothis.mode-STRICTfor performing a strict comparison, orIGNORE_METADATAfor comparing only properties relevant to transformations.- Returns:
trueif both objects are equal.- See Also:
-
computeHashCode
protected long computeHashCode()Invoked byhashCode()for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()for more information.- Overrides:
computeHashCodein classAbstractCRS- Returns:
- the hash code value. This value may change in any future Apache SIS version.
-
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
GeographicCRSorProjectedCRSorEngineeringCRS). - Optionally followed by a
VerticalCRSor aParametricCRS(but not both). - Optionally followed by a
TemporalCRS.
- Overrides:
formatToin 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
-