org.apache.sis.referencing.cs

Class DefaultCompoundCS

Object

FormattableObject

AbstractIdentifiedObject

AbstractCS

DefaultCompoundCS

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, CoordinateSystem, IdentifiedObject

public class DefaultCompoundCS
extends AbstractCS

A coordinate system made of two or more independent coordinate systems.

Permitted associations

Used with CRS	Permitted axis names
Compound	(not applicable)

Immutability and thread safety

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

Serialized Form

Defined in the sis-referencing module

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultCompoundCS(CoordinateSystem... components) Constructs a compound coordinate system from a sequence of coordinate systems.
DefaultCompoundCS(Map<String,?> properties, CoordinateSystem... components) Constructs a coordinate system from a set of properties and a sequence of coordinate systems.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object, ComparisonMode mode) Compares this coordinate system with the specified object for equality.
List<CoordinateSystem>	getComponents() Returns all coordinate systems in this compound CS.

Methods inherited from class AbstractCS

cast­Or­Copy, compute­Hash­Code, for­Convention, format­To, get­Axis, get­Dimension, get­Interface

Methods inherited from class AbstractIdentifiedObject

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

Methods inherited from class FormattableObject

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

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Constructor Detail

DefaultCompoundCS

public DefaultCompoundCS(Map<String,?> properties,
                         CoordinateSystem... components)

Constructs a coordinate system from a set of properties and a sequence of coordinate systems. The properties map is given unchanged to 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()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the identified object.

components - the set of coordinate system.

DefaultCompoundCS

public DefaultCompoundCS(CoordinateSystem... components)

Constructs a compound coordinate system from a sequence of coordinate systems. A default name for this CS will be inferred from the names of all specified CS.

Parameters:

components - the set of coordinate system.

Method Detail

getComponents

public List<CoordinateSystem> getComponents()

Returns all coordinate systems in this compound CS.

Returns:

all coordinate systems in this compound CS.

equals

public boolean equals(Object object,
                      ComparisonMode mode)

Compares this coordinate system with the specified object for equality.

Specified by:

equals in interface Lenient­Comparable

Overrides:

equals in class Abstract­CS

Parameters:

object - the object to compare to this.

mode - STRICT for performing a strict comparison, or IGNORE_METADATA for comparing only properties relevant to coordinate transformations.

Returns:

true if both objects are equal.

See Also:

Abstract­Identified­Object.compute­Hash­Code(), Utilities.deep­Equals(Object, Object, Comparison­Mode)