Package org.apache.sis.referencing.cs
Class DefaultPolarCS
- Object
-
- FormattableObject
-
- AbstractIdentifiedObject
-
- AbstractCS
-
- DefaultPolarCS
-
- All Implemented Interfaces:
Serializable
,Deprecable
,LenientComparable
,CoordinateSystem
,PolarCS
,IdentifiedObject
public class DefaultPolarCS extends AbstractCS implements PolarCS
A 2-dimensional coordinate system for coordinates represented by a distance from the origin and an angle from a fixed direction.Permitted associations Used with CRS Permitted axis names Engineering unspecified Immutability and thread safetyThis class is immutable and thus thread-safe if the property values (not necessarily the map itself) and theCoordinateSystemAxis
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:
DefaultCylindricalCS
,GeodeticAuthorityFactory.createPolarCS(String)
, 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 Description DefaultPolarCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1)
Constructs a two-dimensional coordinate system from a set of properties.protected
DefaultPolarCS(PolarCS cs)
Creates a new coordinate system with the same values than the specified one.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultPolarCS
castOrCopy(PolarCS object)
Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.DefaultPolarCS
forConvention(AxesConvention convention)
Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.Class<? extends PolarCS>
getInterface()
Returns the GeoAPI interface implemented by this class.-
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
-
DefaultPolarCS
public DefaultPolarCS(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
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
- Parameters:
properties
- the properties to be given to the identified object.axis0
- the first axis.axis1
- the second axis.- See Also:
GeodeticObjectFactory.createPolarCS(Map, CoordinateSystemAxis, CoordinateSystemAxis)
-
DefaultPolarCS
protected DefaultPolarCS(PolarCS 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(PolarCS)
-
-
Method Detail
-
castOrCopy
public static DefaultPolarCS castOrCopy(PolarCS object)
Returns a SIS coordinate system 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
public Class<? extends PolarCS> getInterface()
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsPolarCS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not definePolarCS
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classAbstractCS
- Returns:
PolarCS.class
or a user-defined sub-interface.
-
forConvention
public DefaultPolarCS 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 returnsthis
.- Overrides:
forConvention
in classAbstractCS
- 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)
-
-