Package org.apache.sis.referencing.crs

Class DefaultParametricCRS

java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.AbstractReferenceSystem
org.apache.sis.referencing.crs.AbstractCRS
org.apache.sis.referencing.crs.DefaultParametricCRS
All Implemented Interfaces:
Serializable, Formattable, ParametricCRS, Deprecable, LenientComparable, org.opengis.referencing.crs.CoordinateReferenceSystem, org.opengis.referencing.crs.SingleCRS, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem
public class DefaultParametricCRS extends AbstractCRS implements ParametricCRS
A 1-dimensional coordinate reference system which uses parameter values or functions. Parametric CRS can be used for physical properties or functions that vary monotonically with height. A typical example is the pressure in meteorological applications.

Used with datum type: Parametric.
Used with coordinate system type: Parametric.

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum 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.7
Version:
0.7
See Also:

  • Field Details

    • serialVersionUID

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

    • datum

      private DefaultParametricDatum datum
      The datum.

      Consider this field as final! This field is modified only at unmarshalling time by setDatum(ParametricDatum)

      See Also:

  • Constructor Details

    • DefaultParametricCRS

      public DefaultParametricCRS(Map<String,?> properties, DefaultParametricDatum datum, DefaultParametricCS cs)
      Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than for 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" Identifier or String AbstractIdentifiedObject.getName()
      "alias" GenericName or CharSequence (optionally as array) AbstractIdentifiedObject.getAlias()
      "identifiers" Identifier (optionally as array) AbstractIdentifiedObject.getIdentifiers()
      "remarks" InternationalString or String AbstractIdentifiedObject.getRemarks()
      "domainOfValidity" Extent AbstractReferenceSystem.getDomainOfValidity()
      "scope" InternationalString or String AbstractReferenceSystem.getScope()
      Warning: in a future SIS version, the parameter types may be changed to org.opengis.referencing.datum.ParametricDatum and org.opengis.referencing.cs.ParametricCS Those change are pending GeoAPI revision.
      Parameters:
      properties - the properties to be given to the coordinate reference system.
      datum - the datum.
      cs - the coordinate system.

    • DefaultParametricCRS

      protected DefaultParametricCRS(DefaultParametricCRS crs)
      Constructs a new coordinate reference 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.

      Warning: in a future SIS version, the parameter type may be changed to org.opengis.referencing.crs.ParametricCRS. This change is pending GeoAPI revision.
      Parameters:
      crs - the coordinate reference system to copy.

    • DefaultParametricCRS

      private DefaultParametricCRS()
      Constructs a new object in which every attributes are set to a null 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

    • getDatum

      public DefaultParametricDatum getDatum()
      Returns the datum.
      Specified by:
      getDatum in interface org.opengis.referencing.crs.SingleCRS
      Overrides:
      getDatum in class AbstractCRS
      Returns:
      the datum.

    • getCoordinateSystem

      public DefaultParametricCS getCoordinateSystem()
      Returns the coordinate system.
      Specified by:
      getCoordinateSystem in interface org.opengis.referencing.crs.CoordinateReferenceSystem
      Specified by:
      getCoordinateSystem in interface org.opengis.referencing.crs.SingleCRS
      Overrides:
      getCoordinateSystem in class AbstractCRS
      Returns:
      the coordinate system.

    • forConvention

      public DefaultParametricCRS forConvention(AxesConvention convention)
      Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returns this.
      Overrides:
      forConvention in class AbstractCRS
      Parameters:
      convention - the axes convention for which a coordinate reference system is desired.
      Returns:
      a coordinate reference system compatible with the given convention (may be this).
      See Also:

    • createSameType

      final AbstractCRS createSameType(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystem cs)
      Returns a coordinate reference system of the same type than this CRS but with different axes.
      Overrides:
      createSameType in class AbstractCRS

    • formatTo

      protected String formatTo(Formatter formatter)
      Formats this CRS as a Well Known Text ParametricCRS[…] element.
      Compatibility note: ParametricCRS is defined in the WKT 2 specification only.
      Overrides:
      formatTo in class AbstractCRS
      Parameters:
      formatter - the formatter where to format the inner content of this WKT element.
      Returns:
      "ParametricCRS".
      See Also:

    • setDatum

      private void setDatum(DefaultParametricDatum value)
      Invoked by JAXB at unmarshalling time.
      See Also:

    • setCoordinateSystem

      private void setCoordinateSystem(DefaultParametricCS cs)
      Used by JAXB only (invoked by reflection).
      See Also: