Package org.apache.sis.referencing.crs
Class DefaultDerivedCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultDerivedCRS
 All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,CoordinateReferenceSystem
,DerivedCRS
,GeneralDerivedCRS
,SingleCRS
,IdentifiedObject
,ReferenceSystem
A coordinate reference system that is defined by its coordinate conversion
from another CRS (not by a datum).
Those specialized subclasses can be inferred automatically by the
DerivedCRS
can not be projected CRS themselves, but may be derived from a projected CRS
(for example in order to use a polar coordinate system).
A DerivedCRS
instance may also implement one of the interfaces listed below,
provided that the conditions in the right column are met (derived from ISO 19162):
Type  Conditions 

GeodeticCRS  Base CRS is also a GeodeticCRS and is associated to the same type of coordinate system. 
VerticalCRS  Base CRS is also a VerticalCRS and coordinate system is a VerticalCS . 
TemporalCRS  Base CRS is also a TemporalCRS and coordinate system is a TimeCS . 
ParametricCRS  Base CRS is also a ParametricCRS and coordinate system is a ParametricCS . 
EngineeringCRS  Base CRS is a GeodeticCRS , ProjectedCRS or EngineeringCRS . 
create(…)
static method.
Alternatively, users can create their own DefaultDerivedCRS
subclass implementing the desired interface.
Immutability and thread safety
This base class is immutable and thus threadsafe 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,GeneralDerivedCRS
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:
Defined in the sisreferencing
module

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
ModifierConstructorDescriptionprotected
DefaultDerivedCRS
(Map<String, ?> properties, SingleCRS baseCRS, CoordinateReferenceSystem interpolationCRS, OperationMethod method, MathTransform baseToDerived, CoordinateSystem derivedCS) Creates a derived CRS from a math transform.protected
DefaultDerivedCRS
(Map<String, ?> properties, SingleCRS baseCRS, Conversion conversion, CoordinateSystem derivedCS) Creates a derived CRS from a defining conversion.protected
Constructs a new coordinate reference system with the same values than the specified one. 
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultDerivedCRS
castOrCopy
(DerivedCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.protected long
Invoked byhashCode()
for computing the hash code when first needed.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.static DefaultDerivedCRS
create
(Map<String, ?> properties, SingleCRS baseCRS, Conversion conversion, CoordinateSystem derivedCS) Creates a derived CRS from a defining conversion and a type inferred from the given arguments.boolean
equals
(Object object, ComparisonMode mode) Compares this coordinate reference system with the specified object for equality.forConvention
(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected String
Formats the inner part of the Well Known Text (WKT) representation of this CRS.Returns the CRS on which the conversion is applied.Returns the conversion from the base CRS to this CRS.Returns the coordinate system.Returns the datum of the base CRS.Class<? extends DerivedCRS>
Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractCRS
castOrCopy
Methods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScope
Methods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, 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 IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface ReferenceSystem
getDomainOfValidity, getScope

Constructor Details

DefaultDerivedCRS
protected DefaultDerivedCRS(Map<String, ?> properties, SingleCRS baseCRS, Conversion conversion, CoordinateSystem derivedCS) throws MismatchedDimensionExceptionCreates a derived CRS from a defining conversion. The properties given in argument follow the same rules than for the superclass 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
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" Identifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
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.baseCRS
 coordinate reference system to base the derived CRS on.conversion
 the defining conversion from a normalized base to a normalized derived CRS.derivedCS
 the coordinate system for the derived CRS. The number of axes must match the target dimension of thebaseToDerived
transform. Throws:
MismatchedDimensionException
 if the source and target dimensions ofbaseToDerived
do not match the dimensions ofbase
andderivedCS
respectively. See Also:

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 givenMathTransform
shall transform coordinate values specifically from thebaseCRS
tothis
CRS (optionally with an interpolation CRS); there is no consideration about “normalized CRS” in this constructor.Conversion properties
Theproperties
map given in argument can contain any entries documented in the above constructor, together with any entries documented by the conversion constructor provided that theConversion
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
orString
this.getName()
"conversion.name" Identifier
orString
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 theDefaultConversion
object (with keys prefixed by"conversion."
) and to the new derived CRS object.baseCRS
 coordinate reference system to base the derived CRS on.interpolationCRS
 the CRS of additional coordinates needed for the operation, ornull
if none.method
 the coordinate operation method (mandatory in all cases).baseToDerived
 transform from positions in the base CRS to positions in this target CRS.derivedCS
 the coordinate system for the derived CRS. Throws:
IllegalArgumentException
 if at least one argument has an incompatible number of dimensions. See Also:

DefaultDerivedCRS
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 userdefined one (as a subclass), usually in order to leverage some implementationspecific API.This constructor performs a shallow copy, i.e. the properties are not cloned.
 Parameters:
crs
 the coordinate reference system to copy. See Also:


Method Details

create
public static DefaultDerivedCRS create(Map<String, ?> properties, SingleCRS baseCRS, Conversion conversion, CoordinateSystem derivedCS) throws MismatchedDimensionExceptionCreates 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 theDerivedCRS
instance returned by this method may additionally implement theGeodeticCRS
,VerticalCRS
,TemporalCRS
,ParametricCRS
orEngineeringCRS
interface. See the class javadoc for more information. Parameters:
properties
 the properties to be given to the new derived CRS object.baseCRS
 coordinate reference system to base the derived CRS on.conversion
 the defining conversion from a normalized base to a normalized derived CRS.derivedCS
 the coordinate system for the derived CRS. The number of axes must match the target dimension of thebaseToDerived
transform. Returns:
 the newly created derived CRS, potentially implementing an additional CRS interface.
 Throws:
MismatchedDimensionException
 if the source and target dimensions ofbaseToDerived
do not match the dimensions ofbase
andderivedCS
respectively. See Also:

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 theDerivedCRS
instance returned by this method may additionally implement theGeodeticCRS
,VerticalCRS
,TemporalCRS
,ParametricCRS
orEngineeringCRS
interface. See the class javadoc for more information. Parameters:
properties
 the properties to be given to theDefaultConversion
object (with keys prefixed by"conversion."
) and to the new derived CRS object.baseCRS
 coordinate reference system to base the derived CRS on.interpolationCRS
 the CRS of additional coordinates needed for the operation, ornull
if none.method
 the coordinate operation method (mandatory in all cases).baseToDerived
 transform from positions in the base CRS to positions in this target CRS.derivedCS
 the coordinate system for the derived CRS. Returns:
 the newly created derived CRS, potentially implementing an additional CRS interface.
 Throws:
IllegalArgumentException
 if at least one argument has an incompatible number of dimensions. See Also:

castOrCopy
Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation. If the given object isnull
, then this method returnsnull
. 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, ornull
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
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsDerivedCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineDerivedCRS
subinterface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces. Returns:
DerivedCRS.class
or a userdefined subinterface.

getDatum
Returns the datum of the base CRS. Specified by:
getDatum
in interfaceSingleCRS
 Returns:
 the datum of the base CRS.

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:
getBaseCRS
in interfaceGeneralDerivedCRS
 Returns:
 the base coordinate reference system.

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 benull
. Specified by:
getConversionFromBase
in interfaceGeneralDerivedCRS
 Returns:
 the conversion to this CRS.
 The conversion source CRS
is the base CRS of

getCoordinateSystem
Returns the coordinate system. Specified by:
getCoordinateSystem
in interfaceCoordinateReferenceSystem
 Specified by:
getCoordinateSystem
in interfaceSingleCRS
 Overrides:
getCoordinateSystem
in classAbstractCRS
 Returns:
 the coordinate system.

forConvention
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 returnsthis
. Overrides:
forConvention
in classAbstractCRS
 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:

equals
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 givenComparisonMode
isIGNORE_METADATA
orAPPROXIMATE
, then axis order of the base CRS are ignored (but not axis order of this derived CRS). Specified by:
equals
in interfaceLenientComparable
 Parameters:
object
 the object to compare tothis
.mode
STRICT
for performing a strict comparison, orIGNORE_METADATA
for comparing only properties relevant to coordinate transformations. Returns:
true
if both objects are equal. See Also:

computeHashCode
protected long computeHashCode()Invoked byhashCode()
for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()
for more information. Returns:
 the hash code value. This value may change in any future Apache SIS version.

formatTo
Formats the inner part of the Well Known Text (WKT) representation of this CRS. Overrides:
formatTo
in classAbstractCRS
 Parameters:
formatter
 the formatter where to format the inner content of this WKT element. Returns:
"Fitted_CS"
(WKT 1) or a typedependent keyword (WKT 2). See Also:
