Class DefaultCompoundCRS

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

AbstractCRS

DefaultCompoundCRS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Compound­CRS, Coordinate­Reference­System, Identified­Object, Reference­System

public class DefaultCompoundCRS
extends AbstractCRS
implements 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:

Flat list

Compound­CRS — (x, y, z, t)
├─Projected­CRS — (x, y)
├─Vertical­CRS — (z)
└─Temporal­CRS — (t)

Hierarchical structure

Compound­CRS — (x, y, z, t)
├─Compound­CRS — (x, y, z)
│ ├─Projected­CRS — (x, y)
│ └─Vertical­CRS — (z)
└─Temporal­CRS — (t)

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 get­Single­Components() or get­Components() respectively.

Component order

Apache SIS is flexible about the order of components. However, the following order is recommended:

• Horizontal CRS (e.g., two-dimensional Geographic­CRS, Projected­CRS or Engineering­CRS).
• Optionally followed by a Vertical­CRS or a Parametric­CRS (but not both).
• Optionally followed by a Temporal­CRS.

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself) and all Coordinate­Reference­System 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:

• Geodetic­Authority­Factory.create­Compound­CRS(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the object factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Compound­CRS(Map<String,?> properties, Coordinate­Reference­System... components)	Constructs a compound CRS from the given properties and CRS.
protected	Default­Compound­CRS(Compound­CRS crs)	Constructs a new coordinate reference system with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Compound­CRS	cast­Or­Copy(Compound­CRS object)	Returns a SIS CRS implementation with the same values as the given arbitrary implementation.
Default­Compound­CRS	for­Convention(Axes­Convention convention)	Returns a compound CRS equivalent to this one but with axes rearranged according the given convention.
protected String	format­To(Formatter formatter)	Formats this CRS as a Well Known Text Compound­CRS[…] element.
List<Coordinate­Reference­System>	get­Components()	Returns the ordered list of coordinate reference systems.
List<Single­CRS>	get­Single­Components()	Returns the ordered list of single coordinate reference systems.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.

Methods inherited from class AbstractCRS

cast­Or­Copy, get­Coordinate­System

Modifier and Type	Method	Description
static Abstract­CRS	cast­Or­Copy(Coordinate­Reference­System object)	Returns a SIS coordinate reference system implementation with the values of the given arbitrary implementation.
Coordinate­System	get­Coordinate­System()	Returns the coordinate system.

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Scope

Modifier and Type	Method	Description
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Interface, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Constructor Details

DefaultCompoundCRS

public DefaultCompoundCRS(Map<String,?> properties,
 CoordinateReferenceSystem... components)

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 or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	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:

Class­Cast­Exception - if a CRS is neither a Single­CRS or a Compound­CRS.

Illegal­Argument­Exception - 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:

• Geodetic­Object­Factory.create­Compound­CRS(Map, Coordinate­Reference­System...)

DefaultCompoundCRS

protected DefaultCompoundCRS(CompoundCRS crs)

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:

Class­Cast­Exception - if a CRS is neither a Single­CRS or a Compound­CRS.

Method Details

castOrCopy

public static DefaultCompoundCRS castOrCopy(CompoundCRS object)

Returns a SIS CRS implementation with the same values as the given arbitrary implementation. If the given object is null, then this method returns null. 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 null 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.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­CRS

Returns:

Compound­CRS.class or a user-defined sub-interface.

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

getComponents

public List<CoordinateReferenceSystem> getComponents()

Returns the ordered list of coordinate reference systems. This is the list of CRS given at construction time. This list may contain other Compound­CRS instances, as described in class Javadoc. For a flattened list of Single­CRS instances, see get­Single­Components().

Specified by:

get­Components in interface Compound­CRS

Returns:

the coordinate reference systems as an unmodifiable list.

getSingleComponents

public List<SingleCRS> 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 of Single­CRS objects. See class Javadoc for more information.

Returns:

the single coordinate reference systems as an unmodifiable list.

See Also:

• CRS.get­Single­Components(Coordinate­Reference­System)

forConvention

public DefaultCompoundCRS forConvention(AxesConvention convention)

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 is Axes­Convention.DISPLAY_ORIENTED or Axes­Convention.NORMALIZED, this method will also reorder the components with horizontal CRS (geodetic or projected) first, then vertical CRS, then temporal CRS.

Overrides:

for­Convention in class Abstract­CRS

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:

• Abstract­CS.for­Convention(Axes­Convention)

formatTo

protected String formatTo(Formatter formatter)

Formats this CRS as a Well Known Text Compound­CRS[…] 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 Geographic­CRS or Projected­CRS or Engineering­CRS).
• Optionally followed by a Vertical­CRS or a Parametric­CRS (but not both).
• Optionally followed by a Temporal­CRS.

SIS does not check if this CRS is compliant with the above-cited restrictions.

Overrides:

format­To in class Abstract­CRS

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Compound­CRS" (WKT 2) or "Compd_CS" (WKT 1).

See Also:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()