Class DefaultEngineeringCRS

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.DefaultEngineeringCRS
All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.referencing.crs.CoordinateReferenceSystem, org.opengis.referencing.crs.EngineeringCRS, org.opengis.referencing.crs.SingleCRS, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem
public class DefaultEngineeringCRS extends AbstractCRS implements org.opengis.referencing.crs.EngineeringCRS
A 1-, 2- or 3-dimensional contextually local coordinate reference system. It can be divided into two broad categories:
  • earth-fixed systems applied to engineering activities on or near the surface of the earth;
  • CRSs on moving platforms such as road vehicles, vessels, aircraft, or spacecraft.

Used with datum type: Engineering.
Used with coordinate system types: Affine, Cartesian, Cylindrical, Linear. Polar, Spherical or User Defined.

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.4
Version:
1.3
See Also:

  • Field Details

    • serialVersionUID

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

    • datum

      private org.opengis.referencing.datum.EngineeringDatum datum
      The datum.

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

      See Also:

    • SPECIALIZED_TYPES

      private static final Class<?>[] SPECIALIZED_TYPES
      The types for which a specialized method exists. Not including CartesianCS, because this case is already covered by AffineCS.

  • Constructor Details

    • DefaultEngineeringCRS

      public DefaultEngineeringCRS(Map<String,?> properties, org.opengis.referencing.datum.EngineeringDatum datum, org.opengis.referencing.cs.CoordinateSystem 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" 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()
      "domainOfValidity" Extent AbstractReferenceSystem.getDomainOfValidity()
      "scope" InternationalString or String AbstractReferenceSystem.getScope()
      Parameters:
      properties - the properties to be given to the coordinate reference system.
      datum - the datum.
      cs - the coordinate system.
      See Also:

    • DefaultEngineeringCRS

      protected DefaultEngineeringCRS(org.opengis.referencing.crs.EngineeringCRS 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.

      Parameters:
      crs - the coordinate reference system to copy.
      See Also:

    • DefaultEngineeringCRS

      private DefaultEngineeringCRS()
      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

    • castOrCopy

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

    • getDatum

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

    • forConvention

      public DefaultEngineeringCRS 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 EngineeringCRS[…] element.
      Overrides:
      formatTo in class AbstractCRS
      Parameters:
      formatter - the formatter where to format the inner content of this WKT element.
      Returns:
      "EngineeringCRS" (WKT 2) or "Local_CS" (WKT 1).
      See Also:

    • setDatum

      private void setDatum(org.opengis.referencing.datum.EngineeringDatum value)
      Invoked by JAXB at unmarshalling time.
      See Also:

    • getAffineCS

      private org.opengis.referencing.cs.AffineCS getAffineCS()
      Used by JAXB only (invoked by reflection). Only one of getFooCS() methods can return a non-null value.
      Implementation note: The usual way to handle <xs:choice> with JAXB is to annotate a single method like below: However, our attempts to apply this approach worked for DefaultParameterValue but not for this class: for an unknown reason, the unmarshalled CS object is empty.
      See Also:

    • getCartesianCS

      private org.opengis.referencing.cs.CartesianCS getCartesianCS()

    • getCylindricalCS

      private org.opengis.referencing.cs.CylindricalCS getCylindricalCS()

    • getLinearCS

      private org.opengis.referencing.cs.LinearCS getLinearCS()

    • getPolarCS

      private org.opengis.referencing.cs.PolarCS getPolarCS()

    • getSphericalCS

      private org.opengis.referencing.cs.SphericalCS getSphericalCS()

    • getUserDefinedCS

      private org.opengis.referencing.cs.UserDefinedCS getUserDefinedCS()

    • setAffineCS

      private void setAffineCS(org.opengis.referencing.cs.AffineCS cs)
      Invoked by JAXB at unmarshalling time.

    • setCartesianCS

      private void setCartesianCS(org.opengis.referencing.cs.CartesianCS cs)

    • setCylindricalCS

      private void setCylindricalCS(org.opengis.referencing.cs.CylindricalCS cs)

    • setLinearCS

      private void setLinearCS(org.opengis.referencing.cs.LinearCS cs)

    • setPolarCS

      private void setPolarCS(org.opengis.referencing.cs.PolarCS cs)

    • setSphericalCS

      private void setSphericalCS(org.opengis.referencing.cs.SphericalCS cs)

    • setUserDefinedCS

      private void setUserDefinedCS(org.opengis.referencing.cs.UserDefinedCS cs)

    • getAbstractCS

      private org.opengis.referencing.cs.CoordinateSystem getAbstractCS()
      Returns the coordinate system if it is not an instance of any of the types handled by specialized methods. It is the case of EllipsoidalCS, VerticalCS, TimeCS and
      invalid reference 
      ParametricCS
      .

    • setAbstractCS

      private void setAbstractCS(org.opengis.referencing.cs.CoordinateSystem cs)
      Used by JAXB only (invoked by reflection).