Class DefaultConversion

Object

FormattableObject

AbstractIdentifiedObject

AbstractCoordinateOperation

DefaultConversion

All Implemented Interfaces:

Serializable, Formattable, Parameterized, Deprecable, Lenient­Comparable, Printable, Identified­Object, Conversion, Coordinate­Operation, Single­Operation

Direct Known Subclasses:

Defining­Conversion

public class DefaultConversion
extends AbstractCoordinateOperation
implements Conversion

A parameterized mathematical operation that converts coordinates to another CRS without any change of datum. The best-known example of a coordinate conversion is a map projection. The parameters describing coordinate conversions are defined rather than empirically derived.

This coordinate operation contains an operation method, usually with associated parameter values. In the SIS implementation, the parameter values can be either inferred from the math transform or explicitly provided at construction time in a defining conversion.

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, Conversion 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:

• Default­Transformation
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface CoordinateOperation

COORDINATE_OPERATION_ACCURACY_KEY, DOMAIN_OF_VALIDITY_KEY, OPERATION_VERSION_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	COORDINATE_OPERATION_ACCURACY_KEY	Key for the "coordinate­Operation­Accuracy" property.
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property.
static final String	OPERATION_VERSION_KEY	Key for the "operation­Version" property.
static final String	SCOPE_KEY	Key for the "scope" property.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Conversion(Map<String,?> properties, Coordinate­Reference­System source­CRS, Coordinate­Reference­System target­CRS, Coordinate­Reference­System interpolation­CRS, Operation­Method method, Math­Transform transform)	Creates a coordinate conversion from the given properties.
	Default­Conversion(Map<String,?> properties, Operation­Method method, Math­Transform transform, Parameter­Value­Group parameters)	Deprecated, for removal: This API element is subject to removal in a future version. Moved to the Defining­Conversion subclass.
protected	Default­Conversion(Conversion operation)	Creates a new coordinate operation with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Conversion	cast­Or­Copy(Conversion object)	Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.
boolean	equals(Object object, Comparison­Mode mode)	Compares this coordinate operation with the specified object for equality.
Operation­Method	get­Method()	Returns a description of the operation method, including a list of expected parameter names.
Parameter­Descriptor­Group	get­Parameter­Descriptors()	Returns a description of the parameters.
Parameter­Value­Group	get­Parameter­Values()	Returns the parameter values.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
Conversion	specialize(Coordinate­Reference­System source­CRS, Coordinate­Reference­System target­CRS, Math­Transform­Factory factory)	Returns a specialization of this conversion with non-null CRSs.

Methods inherited from class AbstractCoordinateOperation

cast­Or­Copy, format­To, get­Coordinate­Operation­Accuracy, get­Domain­Of­Validity, get­Interpolation­CRS, get­Linear­Accuracy, get­Math­Transform, get­Operation­Version, get­Scope, get­Source­CRS, get­Source­Epoch, get­Target­CRS, get­Target­Epoch, get­Wrap­Around­Changes, is­Defining­Conversion, transform

Modifier and Type	Method	Description
static Abstract­Coordinate­Operation	cast­Or­Copy(Coordinate­Operation object)	Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats this coordinate operation in Well Known Text (WKT) version 2 format.
Collection<Positional­Accuracy>	get­Coordinate­Operation­Accuracy()	Returns an estimation of the impact of this operation on point accuracy.
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Optional<Coordinate­Reference­System>	get­Interpolation­CRS()	Returns the CRS to be used for interpolations in a grid.
double	get­Linear­Accuracy()	Returns an estimation of positional accuracy in metres, or Na­N if unknown.
Math­Transform	get­Math­Transform()	Returns the object for transforming coordinates in the source CRS to coordinates in the target CRS.
String	get­Operation­Version()	Returns the version of the coordinate operation.
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Coordinate­Reference­System	get­Source­CRS()	Returns the source CRS, or null if unspecified.
Optional<Temporal>	get­Source­Epoch()	Returns the date at which source coordinate tuples are valid.
Coordinate­Reference­System	get­Target­CRS()	Returns the target CRS, or null if unspecified.
Optional<Temporal>	get­Target­Epoch()	Returns the date at which target coordinate tuples are valid.
Set<Integer>	get­Wrap­Around­Changes()	Returns the indices of target dimensions where "wrap around" may happen as a result of this coordinate operation.
boolean	is­Defining­Conversion()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by the Defining­Conversion class.
Abstract­Coordinate­Set	transform(Abstract­Coordinate­Set data)	Changes coordinates from being referenced to the source CRS and/or epoch to being referenced to the target CRS and/or epoch.

Methods inherited from class AbstractIdentifiedObject

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

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

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

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

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

Methods inherited from interface Conversion

get­Operation­Version, get­Source­CRS, get­Target­CRS

Modifier and Type	Method	Description
String	get­Operation­Version()	This attribute is declared in Coordinate­Operation but is not used in a conversion.
Coordinate­Reference­System	get­Source­CRS()	Returns the source CRS.
Coordinate­Reference­System	get­Target­CRS()	Returns the target CRS.

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Constructor Details

DefaultConversion

public DefaultConversion(Map<String,?> properties,
 CoordinateReferenceSystem sourceCRS,
 CoordinateReferenceSystem targetCRS,
 CoordinateReferenceSystem interpolationCRS,
 OperationMethod method,
 MathTransform transform)

Creates a coordinate conversion from the given properties. The properties given in argument follow the same rules as 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()
"identifiers"	Identifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domainOfValidity"	Extent	DefaultObjectDomain.getDomainOfValidity()

Relationship between datum

By definition, coordinate conversions do not change the datum. Consequently, the given source­CRS and target­CRS should use the same datum. If the datum is not the same, then the coordinate operation should probably be a transformation instead. However, Apache SIS does not enforce that condition, but we encourage users to follow it. The reason why SIS is tolerant is because some gray areas may exist about whether an operation should be considered as a conversion or a transformation.

Note that while Apache SIS accepts to construct Default­Conversion instances with different source and target datum, it does not accept to use such instances for derived CRS construction.

Example

Converting time instants from a temporal CRS using the January 1st, 1950 epoch to another temporal CRS using the January 1st, 1970 epoch is a datum change, since the epoch is part of temporal datum definition. However, such operation does not have all the accuracy issues of transformations between geodetic reference frames (empirically determined, over-determined systems, stochastic nature of the parameters). Consequently, some users may consider sufficient to represent temporal epoch changes as conversions instead than transformations.

Parameters:

properties - the properties to be given to the identified object.

source­CRS - the source CRS.

target­CRS - the target CRS, which shall use a datum equals (ignoring metadata) to the source CRS datum.

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

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

transform - transform from positions in the source CRS to positions in the target CRS.

DefaultConversion

@Deprecated(since="1.7",
            forRemoval=true)
public DefaultConversion(Map<String,?> properties,
 OperationMethod method,
 MathTransform transform,
 ParameterValueGroup parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

Moved to the Defining­Conversion subclass.

Creates a defining conversion from the given transform and/or parameters.

Parameters:

properties - the properties to be given to the identified object.

method - the operation method.

transform - transform from positions in the source CRS to positions in the target CRS, or null.

parameters - the transform parameter values, or null.

DefaultConversion

protected DefaultConversion(Conversion operation)

Creates a new coordinate operation with the same values as 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:

• cast­Or­Copy(Conversion)

Method Details

castOrCopy

public static DefaultConversion castOrCopy(Conversion object)

Returns a SIS coordinate operation 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 already an instance of Default­Conversion, then it is returned unchanged.
• Otherwise a new Default­Conversion 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.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­Coordinate­Operation

Returns:

Conversion.class or a user-defined sub-interface.

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

specialize

public Conversion specialize(CoordinateReferenceSystem sourceCRS,
 CoordinateReferenceSystem targetCRS,
 MathTransformFactory factory)
                      throws FactoryException

Returns a specialization of this conversion with non-null CRSs. This method is typically invoked on defining conversion instances, when more information become available about the conversion to create. But this method can also be invoked on a fully defined conversion if the caller wants a conversion with slightly different source or target CRS. In the latter case, the changes in the CRSs should be limited to axis order and units of measurement.

Parameters:

source­CRS - the source CRS.

target­CRS - the target CRS.

factory - the factory to use for creating a transform from the parameters or for performing axis changes, or null for the default factory.

Returns:

conversion which declares the given CRSs as the source and target.

Throws:

Mismatched­Datum­Exception - if the given CRSs do not use the same datum as the source and target CRSs of this conversion.

Factory­Exception - if the creation of a Math­Transform from the parameter values, or a change of axis order or units failed.

Since:

1.5

getMethod

public OperationMethod getMethod()

Returns a description of the operation method, including a list of expected parameter names. The returned object does not contains any parameter value.

Specified by:

get­Method in interface Single­Operation

Returns:

a description of the operation method.

getParameterDescriptors

public ParameterDescriptorGroup getParameterDescriptors()

Returns 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 the Math­Transform or from the Operation­Method) should be very similar. If they differ, it should be only in minor details like remarks, default values or units of measurement.

Specified by:

get­Parameter­Descriptors in interface Parameterized

Returns:

a description of the parameters.

See Also:

• Default­Operation­Method.get­Parameters()
• Abstract­Math­Transform.get­Parameter­Descriptors()

getParameterValues

public ParameterValueGroup getParameterValues()

Returns 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 Unsupported­Implementation­Exception.

Specified by:

get­Parameter­Values in interface Parameterized

Specified by:

get­Parameter­Values in interface Single­Operation

Returns:

the parameter values.

Throws:

Unsupported­Operation­Exception - if the parameter values cannot be determined for the current math transform implementation.

See Also:

• Abstract­Math­Transform.get­Parameter­Values()

equals

public boolean equals(Object object,
 ComparisonMode mode)

Compares this coordinate operation with the specified object for equality. If the mode argument is Comparison­Mode.STRICT or BY_CONTRACT, then all available properties are compared including the domains and the accuracy.

Specified by:

equals in interface Lenient­Comparable

Overrides:

equals in class Abstract­Coordinate­Operation

Parameters:

object - the object to compare to this.

mode - the strictness level of the comparison.

Returns:

true if both objects are equal for the given comparison mode.

See Also:

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