Class DefaultAffineCS

All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.referencing.cs.AffineCS, org.opengis.referencing.cs.CoordinateSystem, org.opengis.referencing.IdentifiedObject
Direct Known Subclasses:
DefaultCartesianCS

public class DefaultAffineCS extends AbstractCS implements org.opengis.referencing.cs.AffineCS
A 2- or 3-dimensional coordinate system with straight axes that are not necessarily orthogonal.
Permitted associations
Used with CRS Permitted axis names
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.8
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private 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

    Constructors
    Modifier
    Constructor
    Description
    (package private)
    Constructs a new coordinate system in which every attributes are set to a null or empty value.
    (package private)
    DefaultAffineCS(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axis)
    Constructs a coordinate system of arbitrary dimension.
     
    DefaultAffineCS(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.
     
    DefaultAffineCS(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
    DefaultAffineCS(org.opengis.referencing.cs.AffineCS cs)
    Creates a new coordinate system with the same values than the specified one.
  • Method Summary

    Modifier and Type
    Method
    Description
    castOrCopy(org.opengis.referencing.cs.AffineCS object)
    Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.
    (package private) AbstractCS
    createForAxes(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes)
    Returns a coordinate system with different axes.
    Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.
    Class<? extends org.opengis.referencing.cs.AffineCS>
    Returns the GeoAPI interface implemented by this class.
    (package private) final int
    validateAxis(org.opengis.referencing.cs.AxisDirection direction, javax.measure.Unit<?> unit)
    Returns VALID if the given argument values are allowed for this coordinate system, or an INVALID_* 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.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 serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:
  • Constructor Details

    • DefaultAffineCS

      DefaultAffineCS(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axis)
      Constructs a coordinate system of arbitrary dimension. This constructor is not public because AffineCS are restricted to 2 and 3 dimensions.
    • DefaultAffineCS

      public DefaultAffineCS(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.
      axis1 - the second axis.
      See Also:
    • DefaultAffineCS

      public DefaultAffineCS(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 superclass constructor.
      Parameters:
      properties - the properties to be given to the identified object.
      axis0 - the first axis.
      axis1 - the second axis.
      axis2 - the third axis.
      See Also:
    • DefaultAffineCS

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

      DefaultAffineCS()
      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

      public static DefaultAffineCS castOrCopy(org.opengis.referencing.cs.AffineCS 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.

      This method checks for the CartesianCS sub-interface. If that interface is found, then this method delegates to the corresponding castOrCopy static method.

      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.
    • validateAxis

      final int validateAxis(org.opengis.referencing.cs.AxisDirection direction, javax.measure.Unit<?> unit)
      Returns VALID if the given argument values are allowed for this coordinate system, or an INVALID_* error code otherwise. This method is invoked at construction time.

      The current implementation rejects all directions that are known to be non-spatial, not for grids and not for display. We conservatively accept all others axis directions because some of them are created from strings like "South along 90°E".

      This method accepts linear units, but also accepts the dimensionless units because the later are used for grid and display coordinates.

      Overrides:
      validateAxis in class AbstractCS
      Parameters:
      direction - the direction to test for compatibility (never null).
      unit - the unit to test for compatibility (never null).
      Returns:
      AbstractCS.VALID if the given direction and unit are compatible with this coordinate system, AbstractCS.INVALID_DIRECTION if the direction is invalid or AbstractCS.INVALID_UNIT if the unit is invalid.
    • getInterface

      public Class<? extends org.opengis.referencing.cs.AffineCS> getInterface()
      Returns the GeoAPI interface implemented by this class. The default implementation returns AffineCS.class. Subclasses implementing a more specific GeoAPI interface shall override this method.
      Overrides:
      getInterface in class AbstractCS
      Returns:
      the affine coordinate system interface implemented by this class.
    • forConvention

      public DefaultAffineCS 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 AbstractCS
      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

      AbstractCS createForAxes(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes)
      Returns a coordinate system with different axes. This method shall be overridden by all AffineCS subclasses in this package.
      Overrides:
      createForAxes in class AbstractCS
      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.