AbstractCRS (Apache SIS 0.7 API)

Object
- FormattableObject
- - AbstractIdentifiedObject
  - - AbstractReferenceSystem
    - - AbstractCRS

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, CoordinateReferenceSystem, IdentifiedObject, ReferenceSystem

Direct Known Subclasses:

DefaultCompoundCRS, DefaultDerivedCRS, DefaultEngineeringCRS, DefaultGeocentricCRS, DefaultGeographicCRS, DefaultImageCRS, DefaultParametricCRS, DefaultProjectedCRS, DefaultTemporalCRS, DefaultVerticalCRS
```
public class AbstractCRS
extends AbstractReferenceSystem
implements 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:
```
int dimension = crs.getCoordinateSystem().getDimension();
```
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

See Also:

AbstractCS, AbstractDatum, Serialized Form

Defined in the sis-referencing module

Field Summary
- Fields inherited from class AbstractIdentifiedObject
  DEPRECATED_KEY, LOCALE_KEY
- Fields inherited from interface ReferenceSystem
  DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
- Fields inherited from interface IdentifiedObject
  ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCRS(CoordinateReferenceSystem crs)` Constructs a new coordinate reference system with the same values than the specified one.
	`AbstractCRS(Map<String,?> properties, CoordinateSystem cs)` Creates a coordinate reference system from the given properties and coordinate system.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AbstractCRS`	`castOrCopy(CoordinateReferenceSystem object)` Returns a SIS coordinate reference system implementation with the values of the given arbitrary implementation.
`protected long`	`computeHashCode()` Invoked by `hashCode()` for computing the hash code when first needed.
`boolean`	`equals(Object object, ComparisonMode mode)` Compares this coordinate reference system with the specified object for equality.
`AbstractCRS`	`forConvention(AxesConvention convention)` Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.
`protected String`	`formatTo(Formatter formatter)` Formats the inner part of the Well Known Text (WKT) representation of this CRS.
`CoordinateSystem`	`getCoordinateSystem()` Returns the coordinate system.
`Class<? extends CoordinateReferenceSystem>`	`getInterface()` Returns the GeoAPI interface implemented by this class.

Methods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScope

Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName

Methods inherited from class FormattableObject
print, toString, toString, toWKT

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ReferenceSystem
getDomainOfValidity, getScope

Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

AbstractCRS

public AbstractCRS(Map<String,?> properties,
                   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(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:

castOrCopy(CoordinateReferenceSystem)

Method Detail
- castOrCopy
```
public static AbstractCRS castOrCopy(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, since 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 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.
- getCoordinateSystem
```
public CoordinateSystem getCoordinateSystem()
```
  Returns the coordinate system.
  
  Specified by:
  
  getCoordinateSystem in interface CoordinateReferenceSystem
  
  Returns:
  
  The coordinate system.
- 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:
  
  AbstractCS.forConvention(AxesConvention)
- 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:
  
  AbstractIdentifiedObject.computeHashCode(), Utilities.deepEquals(Object, Object, ComparisonMode)
- 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 than 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:
  
  WKT 2 specification, Legacy WKT 1

Class AbstractCRS

Field Summary

Fields inherited from class AbstractIdentifiedObject

Fields inherited from interface ReferenceSystem

Fields inherited from interface IdentifiedObject

Constructor Summary

Method Summary

Methods inherited from class AbstractReferenceSystem

Methods inherited from class AbstractIdentifiedObject

Methods inherited from class FormattableObject

Methods inherited from class Object

Methods inherited from interface ReferenceSystem

Methods inherited from interface IdentifiedObject

Constructor Detail

AbstractCRS

AbstractCRS

Method Detail

castOrCopy

getInterface

getCoordinateSystem

forConvention

equals

computeHashCode

formatTo