Class AbstractCS

Object
FormattableObject
AbstractIdentifiedObject
AbstractCS
All Implemented Interfaces:
Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Coordinate­System, Identified­Object
Direct Known Subclasses:
Default­Affine­CS, Default­Compound­CS, Default­Cylindrical­CS, Default­Ellipsoidal­CS, Default­Linear­CS, Default­Parametric­CS, Default­Polar­CS, Default­Spherical­CS, Default­Time­CS, Default­User­Defined­CS, Default­Vertical­CS
public class AbstractCS extends AbstractIdentifiedObject implements CoordinateSystem
The set of coordinate system axes that spans a given coordinate space. The type of the coordinate system implies the set of mathematical rules for calculating geometric properties like angles, distances and surfaces.

This class is conceptually abstract, even if it is technically possible to instantiate it. Typical applications should create instances of the most specific subclass with Default prefix instead. An exception to this rule may occurs when it is not possible to identify the exact type. For example, it is not possible to infer the exact coordinate system from Well Known Text (WKT) version 1 in some cases (e.g. in a LOCAL_CS element). In such exceptional situation, a plain Abstract­CS object may be instantiated.

Immutability and thread safety

This base class is immutable and thus thread-safe if the property values (not necessarily the map itself) and the Coordinate­System­Axis instances given to the constructor are also immutable. Most SIS subclasses and related classes are immutable under similar conditions. This means that unless otherwise noted in the javadoc, Coordinate­System instances created using only SIS factories and static constants can be shared by many objects and passed between threads without synchronization.
Since:
0.4
See Also:

  • Constructor Details

  • Method Details

    • castOrCopy

      public static AbstractCS castOrCopy(CoordinateSystem object)
      Returns a SIS coordinate system implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is an instance of Affine­CS, Cartesian­CS, Spherical­CS, Ellipsoidal­CS, Cylindrical­CS, Polar­CS, Linear­CS, Vertical­CS, Time­CS or User­Defined­CS, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the cast­Or­Copy(…) method to be used is unspecified.
      • Otherwise if the given object is already an instance of Abstract­CS, then it is returned unchanged.
      • Otherwise a new Abstract­CS instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other properties contained in the given object are not recursively copied.
      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 CoordinateSystem> getInterface()
      Returns the GeoAPI interface implemented by this class. The default implementation returns Coordinate­System​.class. Subclasses implementing a more specific GeoAPI interface shall override this method.
      Overrides:
      get­Interface in class Abstract­Identified­Object
      Returns:
      the coordinate system interface implemented by this class.

    • getDimension

      public final int getDimension()
      Returns the number of dimensions of this coordinate system. This is the number of axes given at construction time.
      Specified by:
      get­Dimension in interface Coordinate­System
      Returns:
      the number of dimensions of this coordinate system.

    • getAxis

      public final CoordinateSystemAxis getAxis(int dimension) throws IndexOutOfBoundsException
      Returns the axis for this coordinate system at the specified dimension.
      Specified by:
      get­Axis in interface Coordinate­System
      Parameters:
      dimension - the zero based index of axis.
      Returns:
      the axis at the specified dimension.
      Throws:
      Index­Out­Of­Bounds­Exception - if dimension is out of bounds.

    • hasSameAxes

      public final boolean hasSameAxes(CoordinateSystem other)
      Returns whether this coordinate system has the same axes as the specified CS, ignoring axis order.. If true, then the two coordinate systems have the same number of dimensions and the same set of axes. Axis instances are compared by the identity operator (==), not by equals(Object).

      Purpose

      This method can be invoked after a call to for­Convention(Axes­Convention) for checking if that method changed only the axis order, with no change to axis directions, axis ranges or units of measurement.
      Parameters:
      other - the other coordinate system to compare with this CS.
      Returns:
      whether this coordinate system has the same axes as the specified CS, ignoring axis order
      Since:
      1.5

    • forConvention

      public AbstractCS 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.
      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:

    • formatTo

      protected String formatTo(Formatter formatter)
      Formats the inner part of the Well Known Text (WKT) representation of this coordinate system. This method does not format the axes, because they shall appear outside the CS[…] element for historical reasons. Axes shall be formatted by the enclosing element (usually an Abstract­CRS).

      Example

      Well-Known Text of a two-dimensional Ellipsoidal­CS having (φ,λ) axes in a unit defined by the enclosing CRS (usually degrees). 
        CS[ellipsoidal, 2],
  Axis["latitude", north],
  Axis["longitude", east]

      Compatibility note

      CS is defined in the WKT 2 specification only.
      Overrides:
      format­To in class Abstract­Identified­Object
      Parameters:
      formatter - the formatter where to format the inner content of this WKT element.
      Returns:
      "CS".
      See Also: