org.apache.sis.referencing.cs

Class DefaultCartesianCS

Object

FormattableObject

AbstractIdentifiedObject

AbstractCS

DefaultAffineCS

DefaultCartesianCS

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, AffineCS, CartesianCS, CoordinateSystem, IdentifiedObject

public class DefaultCartesianCS
extends DefaultAffineCS
implements CartesianCS

A 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes. All axes shall have the same linear unit of measure.

Permitted associations

Used with CRS	Permitted axis names
Geocentric	“Geocentric X”, “Geocentric Y”, “Geocentric Z”
Projected	“Easting” or “Westing”, “Northing” or “Southing”
Engineering	unspecified
Image	unspecified

Immutability and thread safety

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

Modifier	Constructor and Description
protected	DefaultCartesianCS(CartesianCS cs) Creates a new coordinate system with the same values than the specified one.
	DefaultCartesianCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1) Constructs a two-dimensional coordinate system from a set of properties.
	DefaultCartesianCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a set of properties.

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultCartesianCS	castOrCopy(CartesianCS object) Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.
DefaultCartesianCS	forConvention(AxesConvention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.
Class<? extends CartesianCS>	getInterface() Returns the GeoAPI interface implemented by this class.

Methods inherited from class DefaultAffineCS

castOrCopy

Methods inherited from class AbstractCS

castOrCopy, computeHashCode, equals, formatTo, getAxis, getDimension

Methods inherited from class AbstractIdentifiedObject

castOrCopy, equals, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName

Methods inherited from class FormattableObject

print, toString, toString, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CoordinateSystem

getAxis, getDimension

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

DefaultCartesianCS

public DefaultCartesianCS(Map<String,?> properties,
                  CoordinateSystemAxis axis0,
                  CoordinateSystemAxis axis1)

Constructs a two-dimensional coordinate system from a set of properties. 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 CharSequence (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.

axis0 - The first axis (e.g. “Easting”).

axis1 - The second axis (e.g. “Northing”).

DefaultCartesianCS

public DefaultCartesianCS(Map<String,?> properties,
                  CoordinateSystemAxis axis0,
                  CoordinateSystemAxis axis1,
                  CoordinateSystemAxis axis2)

Constructs a three-dimensional coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

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

axis0 - The first axis (e.g. “Geocentric X”).

axis1 - The second axis (e.g. “Geocentric Y”).

axis2 - The third axis (e.g. “Geocentric Z”).

DefaultCartesianCS

protected DefaultCartesianCS(CartesianCS cs)

Creates a new coordinate 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:

cs - The coordinate system to copy.

See Also:

castOrCopy(CartesianCS)

Method Detail

castOrCopy

public static DefaultCartesianCS castOrCopy(CartesianCS object)

Returns a SIS coordinate system implementation with the same values than 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.

getInterface

public Class<? extends CartesianCS> getInterface()

Returns the GeoAPI interface implemented by this class. The SIS implementation returns CartesianCS.class.

Note for implementors: Subclasses usually do not need to override this method since GeoAPI does not define CartesianCS sub-interface. Overriding possibility is left mostly for implementors who wish to extend GeoAPI with their own set of interfaces.

Overrides:

getInterface in class DefaultAffineCS

Returns:

CartesianCS.class or a user-defined sub-interface.

forConvention

public DefaultCartesianCS forConvention(AxesConvention convention)

Returns a coordinate system equivalent to this one but with axes rearranged according the given convention. If this coordinate system is already compatible with the given convention, then this method returns this.

Overrides:

forConvention in class DefaultAffineCS

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:

AbstractCRS.forConvention(AxesConvention)