Package org.apache.sis.referencing.crs
Class DefaultCompoundCRS
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.DefaultCompoundCRS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.crs.CompoundCRS
,org.opengis.referencing.crs.CoordinateReferenceSystem
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
public class DefaultCompoundCRS
extends AbstractCRS
implements org.opengis.referencing.crs.CompoundCRS
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
GeographicCRS
orProjectedCRS
orEngineeringCRS
). - Optionally followed by a
VerticalCRS
or aParametricCRS
(but not both). - Optionally followed by a
TemporalCRS
.
- Components may appear in different order.
VerticalCRS
+TemporalCRS
(without horizontal component) is accepted.GeocentricCRS
or three-dimensionalGeographicCRS
can 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
- Version:
- 0.8
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> The coordinate reference systems in this compound CRS.private static final long
Serial number for inter-operability with different versions.private List
<org.opengis.referencing.crs.SingleCRS> A decomposition of the CRS list into the single elements.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 or empty value.DefaultCompoundCRS
(Map<String, ?> properties, org.opengis.referencing.crs.CoordinateReferenceSystem... components) Constructs a compound CRS from the given properties and CRS.protected
DefaultCompoundCRS
(org.opengis.referencing.crs.CompoundCRS crs) Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultCompoundCRS
castOrCopy
(org.opengis.referencing.crs.CompoundCRS object) Returns a SIS CRS implementation with the same values than the given arbitrary implementation.protected long
Invoked byhashCode()
for computing the hash code when first needed.private static org.opengis.referencing.cs.CoordinateSystem
createCoordinateSystem
(Map<String, ?> properties, org.opengis.referencing.crs.CoordinateReferenceSystem[] components) Returns a compound coordinate system for the specified array of CRS objects.(package private) final AbstractCRS
createSameType
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Should never be invoked since we overrideAbstractCRS.forConvention(AxesConvention)
.boolean
equals
(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 String
Formats this CRS as a Well Known TextCompoundCRS[…]
element.List
<org.opengis.referencing.crs.CoordinateReferenceSystem> Returns the ordered list of coordinate reference systems.(package private) final org.opengis.referencing.datum.Datum
getDatum()
Compound CRS do not have datum.Class
<? extends org.opengis.referencing.crs.CompoundCRS> Returns the GeoAPI interface implemented by this class.List
<org.opengis.referencing.crs.SingleCRS> Returns the ordered list of single coordinate reference systems.private org.opengis.referencing.crs.CoordinateReferenceSystem[]
Returns the CRS components to marshal.(package private) static boolean
isStandardCompliant
(List<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> singles) Returnstrue
if the sequence of single components is conform to the ISO 19162 restrictions.private void
Computes the single CRS list on deserialization.private void
setComponents
(List<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> crs) Computes thecomponents
andsingles
fields from the given CRS list.private boolean
setSingleComponents
(List<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> crs) Computes thesingles
field from the given CRS list and returnstrue
if the given list was already a list of single CRS.private void
setXMLComponents
(org.opengis.referencing.crs.CoordinateReferenceSystem[] crs) Invoked by JAXB for setting the components of this compound CRS.private static void
verify
(Map<String, ?> properties, org.opengis.referencing.crs.CoordinateReferenceSystem[] components) Verifies that the given array does not contain duplicated horizontal or vertical components.Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, formatCS, getCached, getCoordinateSystem, 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.crs.CoordinateReferenceSystem
getCoordinateSystem
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:
-
components
The coordinate reference systems in this compound CRS. May be the same reference thansingles
.Consider this field as final! This field is modified only at construction and unmarshalling time by
setComponents(List)
-
singles
A decomposition of the CRS list into the single elements. Computed bysetSingleComponents(List)
on construction, deserialization or unmarshalling.
-
-
Constructor Details
-
DefaultCompoundCRS
public DefaultCompoundCRS(Map<String, ?> properties, org.opengis.referencing.crs.CoordinateReferenceSystem... components) 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" 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.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
protected DefaultCompoundCRS(org.opengis.referencing.crs.CompoundCRS 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.
-
DefaultCompoundCRS
private DefaultCompoundCRS()Constructs a new object in which every attributes are set to a null or empty 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
-
verify
private static void verify(Map<String, ?> properties, org.opengis.referencing.crs.CoordinateReferenceSystem[] components) Verifies that the given array does not contain duplicated horizontal or vertical components. Verifies also that if there is an horizontal component, then there is no ellipsoidal height defined separately.- Parameters:
properties
- the user-specified properties, for determining the locale of error messages.components
- the components to verify.
-
createCoordinateSystem
private static org.opengis.referencing.cs.CoordinateSystem createCoordinateSystem(Map<String, ?> properties, org.opengis.referencing.crs.CoordinateReferenceSystem[] components) Returns a compound coordinate system for the specified array of CRS objects.- Parameters:
properties
- the properties given to the constructor, ornull
if unknown.components
- the CRS components, usually singles but not necessarily.- Returns:
- the coordinate system for the given components.
-
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, 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.
-
getDatum
final org.opengis.referencing.datum.Datum getDatum()Compound CRS do not have datum.- Overrides:
getDatum
in classAbstractCRS
- Returns:
- the datum, or
null
if none.
-
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 interfaceorg.opengis.referencing.crs.CompoundCRS
- Returns:
- the coordinate reference systems as an unmodifiable list.
-
setComponents
private void setComponents(List<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> crs) Computes thecomponents
andsingles
fields from the given CRS list. If the two lists have the same content, then the two fields will reference the same list.- See Also:
-
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:
-
setSingleComponents
private boolean setSingleComponents(List<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> crs) Computes thesingles
field from the given CRS list and returnstrue
if the given list was already a list of single CRS.WARNING: this method is invoked by before the components field is set. Do not use that field in this method.
- See Also:
-
readObject
Computes the single CRS list on deserialization.- Parameters:
in
- the input stream from which to deserialize a compound CRS.- Throws:
IOException
- if an I/O error occurred while reading or if the stream contains invalid data.ClassNotFoundException
- if the class serialized on the stream is not on the classpath.
-
isStandardCompliant
static boolean isStandardCompliant(List<? extends org.opengis.referencing.crs.CoordinateReferenceSystem> singles) Returnstrue
if the sequence of single components is conform to the ISO 19162 restrictions. The WKT 2 specification at §16.1 restrictsCompoundCRS
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
.
- Accepts three-dimensional
GeodeticCRS
followed by aTemporalCRS
.
This method is not yet public because of the above-cited limitations: a
true
return value is not a guarantee that the CRS is really standard-compliant.- Returns:
true
if this CRS is "standard" compliant, except for the above-cited limitations.
- A mandatory horizontal CRS (only one of two-dimensional
-
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_ORIENTED
orAxesConvention.NORMALIZED
, then 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:
-
createSameType
final AbstractCRS createSameType(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Should never be invoked since we overrideAbstractCRS.forConvention(AxesConvention)
.- Overrides:
createSameType
in classAbstractCRS
-
equals
Compares this coordinate reference system with the specified object for equality.- Specified by:
equals
in interfaceLenientComparable
- Overrides:
equals
in classAbstractCRS
- Parameters:
object
- the object to compare tothis
.mode
-STRICT
for performing a strict comparison, orIGNORE_METADATA
for comparing only properties relevant to transformations.- Returns:
true
if 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:
computeHashCode
in 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
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
-
getXMLComponents
private org.opengis.referencing.crs.CoordinateReferenceSystem[] getXMLComponents()Returns the CRS components to marshal. We use this private methods instead of annotatinggetSingleComponents()
directly for two reasons:- Use array instead of
List
in order to force JAXB to invoke the setter method. This setter is needed for performing additional work after setting the list of CRS. - Allow a slightly asymmetry: marshal
SingleCRS
components for compliance with the standard, but accept the more genericCoordinateReferenceSystem
elements at unmarshalling time.
- Use array instead of
-
setXMLComponents
private void setXMLComponents(org.opengis.referencing.crs.CoordinateReferenceSystem[] crs) Invoked by JAXB for setting the components of this compound CRS.
-