Package org.apache.sis.referencing.cs

Class DefaultCartesianCS

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.DefaultAffineCS
org.apache.sis.referencing.cs.DefaultCartesianCS
All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.referencing.cs.AffineCS, org.opengis.referencing.cs.CartesianCS, org.opengis.referencing.cs.CoordinateSystem, org.opengis.referencing.IdentifiedObject
public class DefaultCartesianCS extends DefaultAffineCS implements org.opengis.referencing.cs.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
Version:
0.4
Author:
Martin Desruisseaux (IRD, Geomatys)
See Also:

  • Constructor Details

    • DefaultCartesianCS

      public DefaultCartesianCS(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.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”).
      See Also:

    • DefaultCartesianCS

      public DefaultCartesianCS(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.
      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”).
      See Also:

    • DefaultCartesianCS

      protected DefaultCartesianCS(org.opengis.referencing.cs.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:

  • Method Details

    • castOrCopy

      public static DefaultCartesianCS castOrCopy(org.opengis.referencing.cs.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 org.opengis.referencing.cs.CartesianCS> getInterface()
      Returns the GeoAPI interface implemented by this class. The SIS implementation returns CartesianCS.class.
      Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not define CartesianCS sub-interface. Overriding possibility is left mostly for implementers 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: