Class AbstractCRS

All Implemented Interfaces:
Serializable, Formattable, Deprecable, LenientComparable, org.opengis.referencing.crs.CoordinateReferenceSystem, org.opengis.referencing.IdentifiedObject, org.opengis.referencing.ReferenceSystem
Direct Known Subclasses:
AbstractDerivedCRS, DefaultCompoundCRS, DefaultEngineeringCRS, DefaultGeodeticCRS, DefaultImageCRS, DefaultParametricCRS, DefaultTemporalCRS, DefaultVerticalCRS

public class AbstractCRS extends AbstractReferenceSystem implements org.opengis.referencing.crs.CoordinateReferenceSystem
Coordinate reference system, defined by a coordinate system and (usually) a datum. A coordinate reference system (CRS) consists of an ordered sequence of coordinate system axes that are related to the earth through the datum. Most coordinate reference system do not move relative to the earth, except for engineering coordinate reference systems defined on moving platforms such as cars, ships, aircraft, and spacecraft.

Coordinate reference systems can have an arbitrary number of dimensions. The actual dimension of a given instance can be determined as below:

However, most subclasses restrict the allowed number of dimensions.

Instantiation

This class is conceptually abstract, even if it is technically possible to instantiate it. Typical applications should create instances of the most specific subclass prefixed by Default instead. An exception to this rule may occur when it is not possible to identify the exact CRS type.

Immutability and thread safety

This base class is immutable and thus thread-safe if the property values (not necessarily the map itself) 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, CoordinateReferenceSystem instances created using only SIS factories and static constants can be shared by many objects and passed between threads without synchronization.
Since:
0.4
Version:
1.1
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private org.opengis.referencing.cs.CoordinateSystem
    The coordinate system.
    Other coordinate reference systems computed from this CRS by the application of an axes convention.
    private static final long
    Serial number for inter-operability with different versions.

    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

    Fields inherited from interface org.opengis.referencing.ReferenceSystem

    DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    (package private)
    Constructs a new object in which every attributes are set to a null value.
     
    AbstractCRS(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystem cs)
    Creates a coordinate reference system from the given properties and coordinate system.
    protected
    AbstractCRS(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
    Constructs a new coordinate reference system with the same values than the specified one.
  • Method Summary

    Modifier and Type
    Method
    Description
    castOrCopy(org.opengis.referencing.crs.CoordinateReferenceSystem object)
    Returns a SIS coordinate reference system implementation with the values of the given arbitrary implementation.
    protected long
    Invoked by hashCode() for computing the hash code when first needed.
    (package private) 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.
    boolean
    equals(Object object, ComparisonMode mode)
    Compares this coordinate reference system with the specified object for equality.
    Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.
    (package private) final void
    formatCS(Formatter formatter, org.opengis.referencing.cs.CoordinateSystem cs, javax.measure.Unit<?> unit, boolean isWKT1)
    Formats the given coordinate system.
    protected String
    formatTo(Formatter formatter)
    Formats the inner part of the Well Known Text (WKT) representation of this CRS.
    (package private) final AbstractCRS
    Returns the existing CRS for the given convention, or null if none.
    org.opengis.referencing.cs.CoordinateSystem
    Returns the coordinate system.
    (package private) final <T extends org.opengis.referencing.cs.CoordinateSystem>
    T
    Returns the coordinate system if it is of the given type, or null otherwise.
    (package private) org.opengis.referencing.datum.Datum
    Returns the datum, or null if none.
    Class<? extends org.opengis.referencing.crs.CoordinateReferenceSystem>
    Returns the GeoAPI interface implemented by this class.
    (package private) static boolean
    isBaseCRS(Formatter formatter)
    Returns true if the given formatter is in the process of formatting the base CRS of an AbstractDerivedCRS.
    (package private) final AbstractCRS
    Sets the CRS for the given axes convention.
    (package private) final void
    setCoordinateSystem(String name, org.opengis.referencing.cs.CoordinateSystem cs)
    Sets the coordinate system to the given value.

    Methods inherited from class org.apache.sis.referencing.AbstractReferenceSystem

    getDomainOfValidity, getScope

    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.IdentifiedObject

    getAlias, getIdentifiers, getName, getRemarks, toWKT

    Methods inherited from interface org.opengis.referencing.ReferenceSystem

    getDomainOfValidity, getScope
  • Field Details

  • Constructor Details

    • AbstractCRS

      public AbstractCRS(Map<String,?> properties, org.opengis.referencing.cs.CoordinateSystem cs)
      Creates a coordinate reference system from the given properties 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.
      cs - the coordinate system.
    • AbstractCRS

      protected AbstractCRS(org.opengis.referencing.crs.CoordinateReferenceSystem 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:
    • AbstractCRS

      AbstractCRS()
      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 AbstractCRS castOrCopy(org.opengis.referencing.crs.CoordinateReferenceSystem object)
      Returns a SIS coordinate reference 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 GeodeticCRS (including the GeographicCRS and GeocentricCRS subtypes), VerticalCRS, TemporalCRS, EngineeringCRS, ImageCRS or DefaultCompoundCS, then this method delegates to the castOrCopy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the castOrCopy(…) method to be used is unspecified.
      • Otherwise if the given object is already an instance of AbstractCRS, then it is returned unchanged.
      • Otherwise a new AbstractCRS 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 org.opengis.referencing.crs.CoordinateReferenceSystem> getInterface()
      Returns the GeoAPI interface implemented by this class. The default implementation returns CoordinateReferenceSystem.class. Subclasses implementing a more specific GeoAPI interface shall override this method.
      Overrides:
      getInterface in class AbstractReferenceSystem
      Returns:
      the coordinate reference system interface implemented by this class.
    • getDatum

      org.opengis.referencing.datum.Datum getDatum()
      Returns the datum, or null if none. This property does not exist in CoordinateReferenceSystem interface — it is defined in the SingleCRS sub-interface instead. But Apache SIS does not define an AbstractSingleCRS class in order to simplify our class hierarchy, so we provide a datum getter in this class has a hidden property. Subclasses implementing SingleCRS (basically all SIS subclasses except DefaultCompoundCRS) will override this method with public access and more specific return type.
      Returns:
      the datum, or null if none.
    • getCoordinateSystem

      public org.opengis.referencing.cs.CoordinateSystem getCoordinateSystem()
      Returns the coordinate system.
      Specified by:
      getCoordinateSystem in interface org.opengis.referencing.crs.CoordinateReferenceSystem
      Returns:
      the coordinate system.
    • getCoordinateSystem

      final <T extends org.opengis.referencing.cs.CoordinateSystem> T getCoordinateSystem(Class<T> type)
      Returns the coordinate system if it is of the given type, or null otherwise. This method is invoked by subclasses that can accept more than one CS type.
    • getCached

      final AbstractCRS getCached(AxesConvention convention)
      Returns the existing CRS for the given convention, or null if none.
    • setCached

      final AbstractCRS setCached(AxesConvention convention, AbstractCRS crs)
      Sets the CRS for the given axes convention.
      Parameters:
      crs - the CRS to cache.
      Returns:
      the cached CRS. May be different than the given crs if an existing instance has been found.
    • forConvention

      public AbstractCRS 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.
      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

      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. This method shall be overridden by all AbstractCRS subclasses in this package.
    • equals

      public boolean equals(Object object, ComparisonMode mode)
      Compares this coordinate reference system with the specified object for equality. If the mode argument value is STRICT or BY_CONTRACT, then all available properties are compared including the domain of validity and the scope.
      Specified by:
      equals in interface LenientComparable
      Overrides:
      equals in class AbstractReferenceSystem
      Parameters:
      object - the object to compare to this.
      mode - STRICT for performing a strict comparison, or IGNORE_METADATA for comparing only properties relevant to coordinate transformations.
      Returns:
      true if both objects are equal.
      See Also:
    • computeHashCode

      protected long computeHashCode()
      Invoked by hashCode() for computing the hash code when first needed. See AbstractIdentifiedObject.computeHashCode() for more information.
      Overrides:
      computeHashCode in class AbstractReferenceSystem
      Returns:
      the hash code value. This value may change in any future Apache SIS version.
    • formatTo

      protected String formatTo(Formatter formatter)
      Formats the inner part of the Well Known Text (WKT) representation of this CRS. The default implementation writes the following elements in WKT 2 format:
      • The object name.
      • The datum, if any.
      • All coordinate system's axis.
      • The unit if all axes use the same unit, or nothing otherwise.
      The WKT 1 format is similar to the WKT 2 one with two differences:
      • Units are formatted before the axes instead of after the axes.
      • If no unit can be formatted because not all axes use the same unit, then the WKT is flagged as invalid.
      Overrides:
      formatTo in class AbstractIdentifiedObject
      Parameters:
      formatter - the formatter where to format the inner content of this WKT element.
      Returns:
      the CamelCase keyword for the WKT element, or null if unknown.
      See Also:
    • isBaseCRS

      static boolean isBaseCRS(Formatter formatter)
      Returns true if the given formatter is in the process of formatting the base CRS of an AbstractDerivedCRS. In such case, the coordinate system axes shall not be formatted.

      This method should return true when this CRS is the value returned by GeneralDerivedCRS.getBaseCRS() (typically GeneralDerivedCRS.getBaseCRS()). Since the base CRS is the only CRS enclosed in derived CRS, we should have no ambiguity (assuming that the user did not created some weird subclass).

      This method should be invoked for WKT 2 formatting only.

    • formatCS

      final void formatCS(Formatter formatter, org.opengis.referencing.cs.CoordinateSystem cs, javax.measure.Unit<?> unit, boolean isWKT1)
      Formats the given coordinate system.

      In WKT 2 format, this method should not be invoked if isBaseCRS(Formatter) returned true because ISO 19162 excludes the coordinate system definition in base CRS. Note however that WKT 1 includes the coordinate systems. The SIS-specific Convention.INTERNAL formats also those coordinate systems.

      Note: the unit and isWKT1 arguments could be computed by this method, but are requested in order to avoid computing them twice, because the caller usually have them anyway.
      Parameters:
      formatter - the formatter where to append the coordinate system.
      cs - the coordinate system to append.
      unit - the value of ReferencingUtilities.getUnit(cs).
      isWKT1 - true if formatting WKT 1, or false for WKT 2.
    • setCoordinateSystem

      final void setCoordinateSystem(String name, org.opengis.referencing.cs.CoordinateSystem cs)
      Sets the coordinate system to the given value. This method is indirectly invoked by JAXB at unmarshalling time.
      Parameters:
      name - the property name, used only in case of error message to format. Can be null for auto-detect.
      Throws:
      IllegalStateException - if the coordinate system has already been set.