Module org.apache.sis.referencing

Package org.apache.sis.referencing.crs

Class DefaultDerivedCRS

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

AbstractCRS

DefaultDerivedCRS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Coordinate­Reference­System, Derived­CRS, General­Derived­CRS, Single­CRS, Identified­Object, Reference­System

public class DefaultDerivedCRS
extends AbstractCRS
implements DerivedCRS

A coordinate reference system that is defined by its coordinate conversion from another CRS (not by a datum). Derived­CRS cannot be projected CRS themselves, but may be derived from a projected CRS (for example in order to use a polar coordinate system).

A Derived­CRS instance may also implement one of the interfaces listed below, provided that the conditions in the right column are met (derived from ISO 19162):

Derived CRS types

Type	Conditions
GeodeticCRS	Base CRS is also a Geodetic­CRS and is associated to the same type of coordinate system.
VerticalCRS	Base CRS is also a Vertical­CRS and coordinate system is a Vertical­CS.
TemporalCRS	Base CRS is also a Temporal­CRS and coordinate system is a Time­CS.
ParametricCRS	Base CRS is also a Parametric­CRS and coordinate system is a Parametric­CS.
EngineeringCRS	Base CRS is a Geodetic­CRS, Projected­CRS or Engineering­CRS.

Those specialized subclasses can be inferred automatically by the create(…) static method. Alternatively, users can create their own Default­Derived­CRS subclass implementing the desired interface.

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, General­Derived­CRS instances created using only SIS factories and static constants can be shared by many objects and passed between threads without synchronization.

Since:

0.6

See Also:

• Geodetic­Authority­Factory.create­Derived­CRS(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Default­Derived­CRS(Map<String,?> properties, Single­CRS base­CRS, Coordinate­Reference­System interpolation­CRS, Operation­Method method, Math­Transform base­To­Derived, Coordinate­System derived­CS)	Creates a derived CRS from a math transform.
protected	Default­Derived­CRS(Map<String,?> properties, Single­CRS base­CRS, Conversion conversion, Coordinate­System derived­CS)	Creates a derived CRS from a defining conversion.
protected	Default­Derived­CRS(Derived­CRS crs)	Constructs a new coordinate reference system with the same values than the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Derived­CRS	cast­Or­Copy(Derived­CRS object)	Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.
protected long	compute­Hash­Code()	Invoked by hash­Code() for computing the hash code when first needed.
static Default­Derived­CRS	create(Map<String,?> properties, Single­CRS base­CRS, Coordinate­Reference­System interpolation­CRS, Operation­Method method, Math­Transform base­To­Derived, Coordinate­System derived­CS)	Creates a derived CRS from a math transform and a type inferred from the given arguments.
static Default­Derived­CRS	create(Map<String,?> properties, Single­CRS base­CRS, Conversion conversion, Coordinate­System derived­CS)	Creates a derived CRS from a defining conversion and a type inferred from the given arguments.
boolean	equals(Object object, Comparison­Mode mode)	Compares this coordinate reference system with the specified object for equality.
Default­Derived­CRS	for­Convention(Axes­Convention convention)	Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.
protected String	format­To(Formatter formatter)	Formats the inner part of the Well Known Text (WKT) representation of this CRS.
Single­CRS	get­Base­CRS()	Returns the CRS on which the conversion is applied.
Conversion	get­Conversion­From­Base()	Returns the conversion from the base CRS to this CRS.
Coordinate­System	get­Coordinate­System()	Returns the coordinate system.
Datum	get­Datum()	Returns the datum of the base CRS.
Class<? extends Derived­CRS>	get­Interface()	Returns the GeoAPI interface implemented by this class.

Methods inherited from class AbstractCRS

cast­Or­Copy

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Scope

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Methods inherited from interface ReferenceSystem

get­Domain­Of­Validity, get­Scope

Constructor Details

DefaultDerivedCRS

protected DefaultDerivedCRS(Map<String,?> properties,
 SingleCRS baseCRS,
 Conversion conversion,
 CoordinateSystem derivedCS)
                     throws MismatchedDimensionException

Creates a derived CRS from a defining conversion. 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 Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	Identifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

The supplied conversion argument shall not includes the operation steps for performing unit conversions and change of axis order since those operations will be inferred by this constructor.

Parameters:

properties - the properties to be given to the new derived CRS object.

base­CRS - coordinate reference system to base the derived CRS on.

conversion - the defining conversion from a normalized base to a normalized derived CRS.

derived­CS - the coordinate system for the derived CRS. The number of axes must match the target dimension of the base­To­Derived transform.

Throws:

Mismatched­Dimension­Exception - if the source and target dimensions of base­To­Derived do not match the dimensions of base and derived­CS respectively.

See Also:

• create(Map, Single­CRS, Conversion, Coordinate­System)

DefaultDerivedCRS

protected DefaultDerivedCRS(Map<String,?> properties,
 SingleCRS baseCRS,
 CoordinateReferenceSystem interpolationCRS,
 OperationMethod method,
 MathTransform baseToDerived,
 CoordinateSystem derivedCS)

Creates a derived CRS from a math transform. The given Math­Transform shall transform coordinate values specifically from the base­CRS to this CRS (optionally with an interpolation CRS); there is no consideration about “normalized CRS” in this constructor.

Conversion properties

The properties map given in argument can contain any entries documented in the above constructor, together with any entries documented by the conversion constructor provided that the Conversion entry keys are prefixed by "conversion.". In particular, the two first properties listed below are mandatory:

Mandatory properties and some optional properties

Property name	Value type	Returned by
"name"	Identifier or String	this.getName()
"conversion.name"	Identifier or String	conversionFromBase.getName()
Optional properties (non exhaustive list)
"identifiers"	Identifier (optionally as array)	this.getIdentifiers()
"domainOfValidity"	Extent	conversionFromBase.getDomainOfValidity()

Parameters:

properties - the properties to be given to the Default­Conversion object (with keys prefixed by "conversion.") and to the new derived CRS object.

base­CRS - coordinate reference system to base the derived CRS on.

interpolation­CRS - the CRS of additional coordinates needed for the operation, or null if none.

method - the coordinate operation method (mandatory in all cases).

base­To­Derived - transform from positions in the base CRS to positions in this target CRS.

derived­CS - the coordinate system for the derived CRS.

Throws:

Illegal­Argument­Exception - if at least one argument has an incompatible number of dimensions.

See Also:

• create(Map, Single­CRS, Coordinate­Reference­System, Operation­Method, Math­Transform, Coordinate­System)

DefaultDerivedCRS

protected DefaultDerivedCRS(DerivedCRS 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:

• cast­Or­Copy(Derived­CRS)

Method Details

create

public static DefaultDerivedCRS create(Map<String,?> properties,
 SingleCRS baseCRS,
 Conversion conversion,
 CoordinateSystem derivedCS)
                                throws MismatchedDimensionException

Creates a derived CRS from a defining conversion and a type inferred from the given arguments. This method expects the same arguments and performs the same work than the above constructor, except that the Derived­CRS instance returned by this method may additionally implement the Geodetic­CRS, Vertical­CRS, Temporal­CRS, Parametric­CRS or Engineering­CRS interface. See the class javadoc for more information.

Parameters:

properties - the properties to be given to the new derived CRS object.

base­CRS - coordinate reference system to base the derived CRS on.

conversion - the defining conversion from a normalized base to a normalized derived CRS.

derived­CS - the coordinate system for the derived CRS. The number of axes must match the target dimension of the base­To­Derived transform.

Returns:

the newly created derived CRS, potentially implementing an additional CRS interface.

Throws:

Mismatched­Dimension­Exception - if the source and target dimensions of base­To­Derived do not match the dimensions of base and derived­CS respectively.

See Also:

• Default­Derived­CRS(Map, Single­CRS, Conversion, Coordinate­System)
• Geodetic­Object­Factory.create­Derived­CRS(Map, Coordinate­Reference­System, Conversion, Coordinate­System)

create

public static DefaultDerivedCRS create(Map<String,?> properties,
 SingleCRS baseCRS,
 CoordinateReferenceSystem interpolationCRS,
 OperationMethod method,
 MathTransform baseToDerived,
 CoordinateSystem derivedCS)

Creates a derived CRS from a math transform and a type inferred from the given arguments. This method expects the same arguments and performs the same work than the above constructor, except that the Derived­CRS instance returned by this method may additionally implement the Geodetic­CRS, Vertical­CRS, Temporal­CRS, Parametric­CRS or Engineering­CRS interface. See the class javadoc for more information.

Parameters:

properties - the properties to be given to the Default­Conversion object (with keys prefixed by "conversion.") and to the new derived CRS object.

base­CRS - coordinate reference system to base the derived CRS on.

interpolation­CRS - the CRS of additional coordinates needed for the operation, or null if none.

method - the coordinate operation method (mandatory in all cases).

base­To­Derived - transform from positions in the base CRS to positions in this target CRS.

derived­CS - the coordinate system for the derived CRS.

Returns:

the newly created derived CRS, potentially implementing an additional CRS interface.

Throws:

Illegal­Argument­Exception - if at least one argument has an incompatible number of dimensions.

See Also:

• Default­Derived­CRS(Map, Single­CRS, Coordinate­Reference­System, Operation­Method, Math­Transform, Coordinate­System)

castOrCopy

public static DefaultDerivedCRS castOrCopy(DerivedCRS 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 DerivedCRS> getInterface()

Returns the GeoAPI interface implemented by this class. The SIS implementation returns Derived­CRS.class.

Note for implementers

Subclasses usually do not need to override this method since GeoAPI does not define Derived­CRS sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.

Returns:

Derived­CRS.class or a user-defined sub-interface.

getDatum

public Datum getDatum()

Returns the datum of the base CRS.

Specified by:

get­Datum in interface Single­CRS

Returns:

the datum of the base CRS.

getBaseCRS

public SingleCRS getBaseCRS()

Returns the CRS on which the conversion is applied. This CRS defines the datum of this CRS and (at least implicitly) the source of the conversion from base.

Specified by:

get­Base­CRS in interface General­Derived­CRS

Returns:

the base coordinate reference system.

getConversionFromBase

public Conversion getConversionFromBase()

Returns the conversion from the base CRS to this CRS. In Apache SIS, the conversion source and target CRS are set to the following values:

• The conversion source CRS is the base CRS of this CRS.
• The conversion target CRS is this CRS.

Note: This is different than ISO 19111, which allows source and target CRS to be null.

Specified by:

get­Conversion­From­Base in interface General­Derived­CRS

Returns:

the conversion to this CRS.

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

Returns the coordinate system.

Specified by:

get­Coordinate­System in interface Coordinate­Reference­System

Specified by:

get­Coordinate­System in interface Single­CRS

Overrides:

get­Coordinate­System in class Abstract­CRS

Returns:

the coordinate system.

forConvention

public DefaultDerivedCRS 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:

for­Convention in class Abstract­CRS

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:

• Abstract­CS.for­Convention(Axes­Convention)

equals

public boolean equals(Object object,
 ComparisonMode mode)

Compares this coordinate reference system with the specified object for equality. In addition to the metadata documented in the parent class, this method considers coordinate system axes of the base CRS as metadata. This means that if the given Comparison­Mode is IGNORE_METADATA or APPROXIMATE, then axis order of the base CRS are ignored (but not axis order of this derived CRS).

Specified by:

equals in interface Lenient­Comparable

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:

• Abstract­Identified­Object.compute­Hash­Code()
• Utilities.deep­Equals(Object, Object, Comparison­Mode)

computeHashCode

protected long computeHashCode()

Invoked by hash­Code() for computing the hash code when first needed. See Abstract­Identified­Object.compute­Hash­Code() for more information.

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.

Overrides:

format­To in class Abstract­CRS

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Fitted_CS" (WKT 1) or a type-dependent keyword (WKT 2).

See Also:

• WKT 2 specification §15