Class DefaultTransformation
Object
FormattableObject
AbstractIdentifiedObject
AbstractCoordinateOperation
DefaultTransformation
- All Implemented Interfaces:
- Serializable,- Formattable,- Parameterized,- Deprecable,- LenientComparable,- IdentifiedObject,- CoordinateOperation,- SingleOperation,- Transformation
A parameterized mathematical operation that transforms coordinates to another CRS with a change of
 datum.
 The parameters of a coordinate transformation are empirically derived from data containing the coordinates of a
 series of points in both coordinate reference systems. This computational process is usually "over-determined",
 allowing derivation of error (or accuracy) estimates for the
 transformation. Also, the stochastic nature of the parameters may result in multiple (different)
 versions of the same coordinate transformation.
 
This coordinate operation contains an operation method, usually
 with associated parameter values. In the SIS default implementation, the parameter values are inferred from the
 math transform. Subclasses may have to override the SingleOperation.getParameterValues()
 method if they need to provide a different set of parameters.
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. This means that unless otherwise noted in the javadoc,Transformation 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 sis-referencing module
- 
Field SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, LOCALE_KEYFields inherited from interface CoordinateOperationCOORDINATE_OPERATION_ACCURACY_KEY, DOMAIN_OF_VALIDITY_KEY, OPERATION_VERSION_KEY, SCOPE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultTransformation(Map<String, ?> properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, CoordinateReferenceSystem interpolationCRS, OperationMethod method, MathTransform transform) Creates a coordinate transformation from the given properties.protectedDefaultTransformation(Transformation operation) Creates a new coordinate operation with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultTransformationcastOrCopy(Transformation object) Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.booleanequals(Object object, ComparisonMode mode) Compares this coordinate operation with the specified object for equality.Class<? extends Transformation>Returns the GeoAPI interface implemented by this class.Returns a description of the operation method, including a list of expected parameter names.Returns a description of the parameters.Returns the parameter values.Methods inherited from class AbstractCoordinateOperationcastOrCopy, computeHashCode, formatTo, getCoordinateOperationAccuracy, getDomainOfValidity, getInterpolationCRS, getLinearAccuracy, getMathTransform, getOperationVersion, getScope, getSourceCRS, getTargetCRS, getWrapAroundChanges, isDefiningConversionMethods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface CoordinateOperationgetCoordinateOperationAccuracy, getDomainOfValidity, getMathTransform, getScopeMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKTMethods inherited from interface SingleOperationgetMethod, getParameterValuesMethods inherited from interface TransformationgetOperationVersion, getSourceCRS, getTargetCRS
- 
Constructor Details- 
DefaultTransformationpublic DefaultTransformation(Map<String, ?> properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, CoordinateReferenceSystem interpolationCRS, OperationMethod method, MathTransform transform) Creates a coordinate transformation from the given properties. 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" IdentifierorStringAbstractIdentifiedObject.getName()"identifiers" Identifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"coordinateOperationAccuracy" PositionalAccuracy(optionally as array)AbstractCoordinateOperation.getCoordinateOperationAccuracy()"domainOfValidity" ExtentAbstractCoordinateOperation.getDomainOfValidity()- Parameters:
- properties- the properties to be given to the identified object.
- sourceCRS- the source CRS.
- targetCRS- the target CRS.
- interpolationCRS- the CRS of additional coordinates needed for the operation, or- nullif none.
- method- the coordinate operation method (mandatory in all cases).
- transform- transform from positions in the source CRS to positions in the target CRS.
 
- 
DefaultTransformationCreates a new coordinate operation 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:
- operation- the coordinate operation to copy.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS coordinate operation implementation with the values of the given arbitrary implementation. If the given object is already an instance ofDefaultTransformation, then it is returned unchanged. Otherwise a newDefaultTransformationinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The SIS implementation returnsTransformation.class.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineTransformationsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
- getInterfacein class- AbstractCoordinateOperation
- Returns:
- Transformation.classor a user-defined sub-interface.
 
- 
getMethodReturns a description of the operation method, including a list of expected parameter names. The returned object does not contains any parameter value.- Specified by:
- getMethodin interface- SingleOperation
- Returns:
- a description of the operation method.
 
- 
getParameterDescriptorsReturns a description of the parameters. The default implementation performs the following choice:- If parameter values were specified explicitly at construction time, then the descriptor of those parameters is returned.
- Otherwise if this method can infer the parameter descriptor from the math transform, then that descriptor is returned.
- Otherwise fallback on the method parameters.
 Note: the two parameter descriptions (from theMathTransformor from theOperationMethod) should be very similar. If they differ, it should be only in minor details like remarks, default values or units of measurement.- Specified by:
- getParameterDescriptorsin interface- Parameterized
- Returns:
- a description of the parameters.
- See Also:
 
- 
getParameterValuesReturns the parameter values. The default implementation performs the following choice:- If parameter values were specified explicitly at construction time, then they are returned as an unmodifiable parameter group.
- Otherwise if this method can infer the parameter values from the math transform, then those parameters are returned.
- Otherwise throw UnsupportedImplementationException.
 - Specified by:
- getParameterValuesin interface- Parameterized
- Specified by:
- getParameterValuesin interface- SingleOperation
- Returns:
- the parameter values.
- Throws:
- UnsupportedOperationException- if the parameter values cannot be determined for the current math transform implementation.
- See Also:
 
- 
equalsCompares this coordinate operation with the specified object for equality. If themodeargument isComparisonMode.STRICTorBY_CONTRACT, then all available properties are compared including the domain of validity and the scope.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractCoordinateOperation
- Parameters:
- object- the object to compare to- this.
- mode-- STRICTfor performing a strict comparison, or- IGNORE_METADATAfor ignoring properties that do not make a difference in the numerical results of coordinate operations.
- Returns:
- trueif both objects are equal for the given comparison mode.
- See Also:
 
 
-