Package org.apache.sis.referencing.cs

Class DefaultLinearCS

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.DefaultLinearCS
All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.referencing.cs.CoordinateSystem, org.opengis.referencing.cs.LinearCS, org.opengis.referencing.IdentifiedObject
public class DefaultLinearCS extends AbstractCS implements org.opengis.referencing.cs.LinearCS
A 1-dimensional coordinate system for points that lie on a single axis (not necessarily a straight line). Coordinate values are distances from the axis origin to the point along the axis. A typical example is an axis for representing the points along a road.
Permitted associations
Used with CRS Permitted axis names
Engineering 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
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:

  • Constructor Details

    • DefaultLinearCS

      private DefaultLinearCS(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 the createForAxes(Map, CoordinateSystemAxis[]) method only, because it does not verify the number of axes.

    • DefaultLinearCS

      public DefaultLinearCS(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis axis)
      Constructs a 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.
      axis - the axis.
      See Also:

    • DefaultLinearCS

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

    • DefaultLinearCS

      private DefaultLinearCS()
      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 DefaultLinearCS castOrCopy(org.opengis.referencing.cs.LinearCS 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.

    • 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. We conservatively accept custom axis directions because some of them are created from strings like "South along 90°E".

      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.LinearCS> getInterface()
      Returns the GeoAPI interface implemented by this class. The SIS implementation returns LinearCS.class.
      Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not define LinearCS sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.
      Overrides:
      getInterface in class AbstractCS
      Returns:
      LinearCS.class or a user-defined sub-interface.

    • forConvention

      public DefaultLinearCS 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

      final AbstractCS createForAxes(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystemAxis[] axes)
      Returns a coordinate system with different axes.
      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.