Package org.apache.sis.referencing.crs
Class DefaultCompoundCRS
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-dimensional- GeographicCRScan be combined with- 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:
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_KEYFields inherited from interface ReferenceSystemDOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultCompoundCRS(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 SummaryModifier 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 AbstractCRScastOrCopy, getCoordinateSystemMethods inherited from class AbstractReferenceSystemgetDomainOfValidity, getScopeMethods 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 CoordinateReferenceSystemgetCoordinateSystemMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKTMethods inherited from interface ReferenceSystemgetDomainOfValidity, getScope
- 
Constructor Details- 
DefaultCompoundCRSConstructs 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()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"domainOfValidity" ExtentAbstractReferenceSystem.getDomainOfValidity()"scope" InternationalStringorStringAbstractReferenceSystem.getScope()- 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:
 
- 
DefaultCompoundCRSConstructs 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- 
castOrCopyReturns 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, 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 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 class- AbstractCRS
- Returns:
- CompoundCRS.classor a user-defined sub-interface.
 
- 
getComponentsReturns 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 interface- CompoundCRS
- Returns:
- the coordinate reference systems as an unmodifiable list.
 
- 
getSingleComponentsReturns 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:
 
- 
forConventionReturns 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 class- AbstractCRS
- 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:
 
- 
equalsCompares this coordinate reference system with the specified object for equality.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractCRS
- Parameters:
- object- the object to compare to- this.
- mode-- STRICTfor performing a strict comparison, or- IGNORE_METADATAfor comparing only properties relevant to transformations.
- Returns:
- trueif both objects are equal.
- See Also:
 
- 
computeHashCodeprotected long computeHashCode()Invoked byhashCode()for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()for more information.- Overrides:
- computeHashCodein class- AbstractCRS
- Returns:
- the hash code value. This value may change in any future Apache SIS version.
 
- 
formatToFormats this CRS as a Well Known TextCompoundCRS[…]element.WKT validityThe 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 class- AbstractCRS
- 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 
 
-