Class DefaultCompoundCS

Object

FormattableObject

AbstractIdentifiedObject

AbstractCS

DefaultCompoundCS

All Implemented Interfaces:

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

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

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.

Constructor Summary

Constructors

Constructor	Description
Default­Compound­CS(Map<String,?> properties, Coordinate­System... components)	Constructs a coordinate system from a set of properties and a sequence of coordinate systems.
Default­Compound­CS(Coordinate­System... components)	Constructs a compound coordinate system from a sequence of coordinate systems.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object, Comparison­Mode mode)	Compares this coordinate system with the specified object for equality.
Default­Compound­CS	for­Convention(Axes­Convention convention)	Returns a compound CS equivalent to this one but with axes rearranged according the given convention.
List<Coordinate­System>	get­Components()	Returns all coordinate systems in this compound CS.

Methods inherited from class AbstractCS

cast­Or­Copy, format­To, get­Axis, get­Dimension, get­Standard­Type, has­Same­Axes

Modifier and Type	Method	Description
static Abstract­CS	cast­Or­Copy(Coordinate­System object)	Returns a SIS coordinate system implementation with the values of the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats the inner part of the Well Known Text (WKT) representation of this coordinate system.
final Coordinate­System­Axis	get­Axis(int dimension)	Returns the axis for this coordinate system at the specified dimension.
final int	get­Dimension()	Returns the number of dimensions of this coordinate system.
Class<? extends Coordinate­System>	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
final boolean	has­Same­Axes(Coordinate­System other)	Returns whether this coordinate system has the same axes as the specified CS, ignoring axis order.

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

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 Details

getComponents

public List<CoordinateSystem> getComponents()

Returns all coordinate systems in this compound CS.

Returns:

all coordinate systems in this compound CS.

forConvention

public DefaultCompoundCS forConvention(AxesConvention convention)

Returns a compound CS equivalent to this one but with axes rearranged according the given convention. This method reorders the axes of each individual coordinate system component.

Overrides:

for­Convention in class Abstract­CS

Parameters:

convention - the axes convention for which a coordinate system is desired.

Returns:

a coordinate system compatible with the given convention (may be this).

See Also:

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

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­Identified­Object

Parameters:

object - the object to compare to this.

mode - the strictness level of the comparison.

Returns:

true if both objects are equal.

See Also:

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