Module org.opengis.geoapi.example

Package org.opengis.example.referencing

Class SimpleTransformFactory

Object

SimpleTransformFactory

All Implemented Interfaces:

MathTransformFactory, Factory

public class SimpleTransformFactory
extends Object
implements MathTransformFactory

A MathTransformFactory for creating SimpleTransform instances. The only methods supported by this simple implementation are:

• getVendor()
• getAvailableMethods(Class), which returns an empty set.
• getLastMethodUsed(), which returns null.
• createAffineTransform(Matrix)

Since:

3.1

Constructor Summary

Constructors

Constructor	Description
SimpleTransformFactory()	Creates a new factory.

Method Summary

Modifier and Type	Method	Description
MathTransform	createAffineTransform(Matrix matrix)	Creates an affine transform from a matrix.
MathTransform	createBaseToDerived(CoordinateReferenceSystem baseCRS, ParameterValueGroup parameters, CoordinateSystem derivedCS)	Creates a parameterized transform from a base CRS to a derived CS.
MathTransform	createConcatenatedTransform(MathTransform transform1, MathTransform transform2)	Creates a transform by concatenating two existing transforms.
MathTransform	createFromWKT(String wkt)	Creates a transform from a WKT string.
MathTransform	createParameterizedTransform(ParameterValueGroup parameters)	Creates a transform from a group of parameters.
MathTransform	createPassThroughTransform(int firstAffectedCoordinate, MathTransform subTransform, int numTrailingCoordinates)	Creates a transform which passes through a subset of coordinates to another transform.
Set<OperationMethod>	getAvailableMethods(Class<? extends SingleOperation> type)	Returns a set of available methods for math transforms.
ParameterValueGroup	getDefaultParameters(String method)	Returns the default parameter values for a math transform using the given method.
OperationMethod	getLastMethodUsed()	Returns the operation method used for the latest call to createParameterizedTransform, or null if not applicable.
Citation	getVendor()	Returns the implementer of this factory.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface MathTransformFactory

createFromXML

Constructor Details

SimpleTransformFactory

public SimpleTransformFactory()

Creates a new factory.

Method Details

getVendor

public Citation getVendor()

Returns the implementer of this factory.

Specified by:

getVendor in interface Factory

Returns:

the vendor for this factory implementation.

getAvailableMethods

public Set<OperationMethod> getAvailableMethods(Class<? extends SingleOperation> type)

Returns a set of available methods for math transforms. The default implementation returns an empty set.

Specified by:

getAvailableMethods in interface MathTransformFactory

Parameters:

type - SingleOperation.class for fetching all operation methods, Projection.class for fetching only map projection methods, etc.

Returns:

methods available in this factory for coordinate operations of the given type.

See Also:

• MathTransformFactory.getDefaultParameters(String)
• MathTransformFactory.createParameterizedTransform(ParameterValueGroup)
• CoordinateOperationFactory.getOperationMethod(String)

getLastMethodUsed

public OperationMethod getLastMethodUsed()

Returns the operation method used for the latest call to createParameterizedTransform, or null if not applicable. The default implementation returns null in all cases.

Specified by:

getLastMethodUsed in interface MathTransformFactory

Returns:

the last method used by a create(…) constructor, or null if unknown of unsupported.

See Also:

• MathTransformFactory.createParameterizedTransform(ParameterValueGroup)

getDefaultParameters

public ParameterValueGroup getDefaultParameters(String method)
                                         throws NoSuchIdentifierException

Returns the default parameter values for a math transform using the given method. The default implementation throws an exception in all cases since parameterized transforms are not implemented by this simple factory.

Specified by:

getDefaultParameters in interface MathTransformFactory

Parameters:

method - the case insensitive name of the coordinate operation method to search for.

Returns:

a new group of parameter values for the OperationMethod identified by the given name.

Throws:

NoSuchIdentifierException - if there is no method registered for the given name or identifier.

See Also:

• MathTransformFactory.getAvailableMethods(Class)
• MathTransformFactory.createParameterizedTransform(ParameterValueGroup)

createBaseToDerived

public MathTransform createBaseToDerived(CoordinateReferenceSystem baseCRS,
 ParameterValueGroup parameters,
 CoordinateSystem derivedCS)
                                  throws FactoryException

Creates a parameterized transform from a base CRS to a derived CS. The default implementation throws an exception in all cases since parameterized transforms are not implemented by this simple factory.

Specified by:

createBaseToDerived in interface MathTransformFactory

Parameters:

baseCRS - the source coordinate reference system.

parameters - the parameter values for the transform.

derivedCS - the target coordinate system.

Returns:

the parameterized transform from baseCRS to derivedCS, including unit conversions and axis swapping.

Throws:

NoSuchIdentifierException - if there is no transform registered for the coordinate operation method.

FactoryException - if the object creation failed. This exception is thrown if some required parameter has not been supplied, or has illegal value.

createParameterizedTransform

public MathTransform createParameterizedTransform(ParameterValueGroup parameters)
                                           throws FactoryException

Creates a transform from a group of parameters. The default implementation throws an exception in all cases since parameterized transforms are not implemented by this simple factory.

Specified by:

createParameterizedTransform in interface MathTransformFactory

Parameters:

parameters - the parameter values.

Returns:

the parameterized transform.

Throws:

NoSuchIdentifierException - if there is no transform registered for the coordinate operation method.

FactoryException - if the object creation failed. This exception is thrown if some required parameter has not been supplied, or has illegal value.

See Also:

• MathTransformFactory.getDefaultParameters(String)
• MathTransformFactory.getAvailableMethods(Class)
• MathTransformFactory.getLastMethodUsed()

createAffineTransform

public MathTransform createAffineTransform(Matrix matrix)
                                    throws FactoryException

Creates an affine transform from a matrix. If the transform's input dimension is M, and output dimension is N, then the matrix will have size [N+1][M+1]. The +1 in the matrix dimensions allows the matrix to do a shift, as well as a rotation. The [M][j] element of the matrix will be the j'th coordinate of the moved origin. The [i][N] element of the matrix will be 0 for i less than M, and 1 for i equals M.

Specified by:

createAffineTransform in interface MathTransformFactory

Parameters:

matrix - the matrix used to define the affine transform.

Returns:

the affine transform.

Throws:

FactoryException - if the object creation failed.

See Also:

• AffineTransform2D
• ProjectiveTransform

createConcatenatedTransform

public MathTransform createConcatenatedTransform(MathTransform transform1,
 MathTransform transform2)
                                          throws FactoryException

Creates a transform by concatenating two existing transforms. The default implementation throws an exception in all cases since concatenated transforms are not implemented by this simple factory.

Specified by:

createConcatenatedTransform in interface MathTransformFactory

Parameters:

transform1 - the first transform to apply to points.

transform2 - the second transform to apply to points.

Returns:

the concatenated transform.

Throws:

FactoryException - if the object creation failed.

createPassThroughTransform

public MathTransform createPassThroughTransform(int firstAffectedCoordinate,
 MathTransform subTransform,
 int numTrailingCoordinates)
                                         throws FactoryException

Creates a transform which passes through a subset of coordinates to another transform. The default implementation throws an exception in all cases since pass through transforms are not implemented by this simple factory.

Specified by:

createPassThroughTransform in interface MathTransformFactory

Parameters:

firstAffectedCoordinate - the lowest index of the affected coordinates.

subTransform - transform to use for affected coordinates.

numTrailingCoordinates - number of trailing coordinates to pass through. Affected coordinates will range from firstAffectedCoordinate inclusive to dimTarget-numTrailingCoordinates exclusive.

Returns:

a pass through transform with the following dimensions:

 Source: firstAffectedCoordinate + subTransform.getDimSource() + numTrailingCoordinates
 Target: firstAffectedCoordinate + subTransform.getDimTarget() + numTrailingCoordinates

Throws:

FactoryException - if the object creation failed.

createFromWKT

public MathTransform createFromWKT(String wkt)
                            throws FactoryException

Creates a transform from a WKT string. The default implementation throws an exception in all cases since WKT parsing is not implemented by this simple factory.

Specified by:

createFromWKT in interface MathTransformFactory

Parameters:

wkt - math transform encoded in Well-Known Text format.

Returns:

the math transform (never null).

Throws:

FactoryException - if the Well-Known Text can't be parsed, or if the math transform creation failed from some other reason.

See Also:

• MathTransform.toWKT()