Package org.apache.sis.referencing.cs
Class DefaultSphericalCS
java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.cs.AbstractCS
org.apache.sis.referencing.cs.DefaultSphericalCS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.cs.CoordinateSystem
,org.opengis.referencing.cs.SphericalCS
,org.opengis.referencing.IdentifiedObject
public class DefaultSphericalCS
extends AbstractCS
implements org.opengis.referencing.cs.SphericalCS
A 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates.
Not to be confused with an ellipsoidal coordinate system
based on an ellipsoid "degenerated" into a sphere.
Used with CRS | Permitted axis names |
---|---|
Geocentric | “Spherical Latitude”, “ Spherical Longitude”, “Geocentric Radius” |
Engineering | unspecified |
Immutability and thread safety
This 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
- Version:
- 0.4
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.referencing.cs.AbstractCS
INVALID_DIRECTION, INVALID_UNIT, VALID
Fields inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructs a new coordinate system in which every attributes are set to a null or empty value.private
DefaultSphericalCS
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes) Creates a new coordinate system from an arbitrary number of axes.DefaultSphericalCS
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.CoordinateSystemAxis axis1, org.opengis.referencing.cs.CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a set of properties.protected
DefaultSphericalCS
(org.opengis.referencing.cs.SphericalCS cs) Creates a new coordinate system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultSphericalCS
castOrCopy
(org.opengis.referencing.cs.SphericalCS object) Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.(package private) final AbstractCS
createForAxes
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes) Returns a coordinate system with different axes.forConvention
(AxesConvention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.Class<? extends org.opengis.referencing.cs.SphericalCS>
Returns the GeoAPI interface implemented by this class.(package private) final int
validateAxis
(org.opengis.referencing.cs.AxisDirection direction, javax.measure.Unit<?> unit) ReturnsVALID
if the given argument values are allowed for this coordinate system, or anINVALID_*
error code otherwise.Methods inherited from class org.apache.sis.referencing.cs.AbstractCS
castOrCopy, computeHashCode, equals, formatTo, getAxis, getDimension, unexpectedDimension
Methods inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toString, toWKT
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.cs.CoordinateSystem
getAxis, getDimension
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
-
Constructor Details
-
DefaultSphericalCS
private DefaultSphericalCS(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes) Creates a new coordinate system from an arbitrary number of axes. This constructor is for implementations of thecreateForAxes(Map, CoordinateSystemAxis[])
method only, because it does not verify the number of axes. -
DefaultSphericalCS
public DefaultSphericalCS(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.CoordinateSystemAxis axis1, org.opengis.referencing.cs.CoordinateSystemAxis axis2) Constructs a three-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 (e.g. “Spherical latitude”).axis1
- the second axis (e.g. “Spherical longitude”).axis2
- the third axis (e.g. “Geocentric radius”).- See Also:
-
DefaultSphericalCS
protected DefaultSphericalCS(org.opengis.referencing.cs.SphericalCS 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:
-
DefaultSphericalCS
private DefaultSphericalCS()Constructs a new coordinate system in which every attributes are set to a null or empty value. This is not a valid object. This constructor is strictly reserved to JAXB, which will assign values to the fields using reflection.
-
-
Method Details
-
castOrCopy
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.
-
validateAxis
final int validateAxis(org.opengis.referencing.cs.AxisDirection direction, javax.measure.Unit<?> unit) ReturnsVALID
if the given argument values are allowed for this coordinate system, or anINVALID_*
error code otherwise. This method is invoked at construction time.The current implementation rejects all directions that are known to be non-spatial.
- Overrides:
validateAxis
in classAbstractCS
- Parameters:
direction
- the direction to test for compatibility (nevernull
).unit
- the unit to test for compatibility (nevernull
).- Returns:
AbstractCS.VALID
if the given direction and unit are compatible with this coordinate system,AbstractCS.INVALID_DIRECTION
if the direction is invalid orAbstractCS.INVALID_UNIT
if the unit is invalid.
-
getInterface
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsSphericalCS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineSphericalCS
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:
SphericalCS.class
or a user-defined sub-interface.
-
forConvention
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:
-
createForAxes
final AbstractCS createForAxes(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes) Returns a coordinate system with different axes.- Overrides:
createForAxes
in classAbstractCS
axes
- the set of axes to give to the new coordinate system.- Returns:
- a new coordinate system of the same type than
this
, but using the given axes.
-