Package org.apache.sis.referencing.operation.transform

Class DefaultMathTransformFactory.Context

java.lang.Object
org.apache.sis.referencing.operation.transform.DefaultMathTransformFactory.Context
All Implemented Interfaces:
Serializable
Enclosing class:
DefaultMathTransformFactory
public static class DefaultMathTransformFactory.Context extends Object implements Serializable
Source and target coordinate systems for which a new parameterized transform is going to be used. DefaultMathTransformFactory uses this information for:
  • Completing some parameters if they were not provided. In particular, the source ellipsoid can be used for providing values for the "semi_major" and "semi_minor" parameters in map projections.
  • Swapping and scaling axes if the source or the target coordinate systems are not normalized.
This class does not handle change of prime meridian or anything else related to datum. Datum changes have dedicated OperationMethod, for example "Longitude rotation" (EPSG:9601) for changing the prime meridian.

Scope

Instances of this class should be short-lived (they exist only the time needed for creating a MathTransform) and should not be shared (because they provide no immutability guarantees). This class is not thread-safe.
Since:
0.7
Version:
1.3
Author:
Martin Desruisseaux (Geomatys)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Context()
    Creates a new context with all properties initialized to null.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opengis.parameter.ParameterValueGroup
    getCompletedParameters()
    Returns the parameter values used for the math transform creation, including the parameters completed by the factory.
    Map<String,Boolean>
    getContextualParameters()
    Returns the names of parameters that have been inferred from the context.
    org.opengis.referencing.operation.Matrix
    getMatrix(ContextualParameters.MatrixRole role)
    Returns the matrix that represent the affine transform to concatenate before or after the parameterized transform.
    org.opengis.referencing.operation.OperationMethod
    getMethodUsed()
    Returns the operation method used for the math transform creation.
    org.opengis.referencing.cs.CoordinateSystem
    getSourceCS()
    Returns the source coordinate system, or null if unspecified.
    org.opengis.referencing.datum.Ellipsoid
    getSourceEllipsoid()
    Returns the ellipsoid of the source ellipsoidal coordinate system, or null if it does not apply.
    org.opengis.referencing.cs.CoordinateSystem
    getTargetCS()
    Returns the target coordinate system, or null if unspecified.
    org.opengis.referencing.datum.Ellipsoid
    getTargetEllipsoid()
    Returns the ellipsoid of the target ellipsoidal coordinate system, or null if it does not apply.
    void
    setSource(org.opengis.referencing.crs.GeodeticCRS crs)
    Sets the source coordinate system and related ellipsoid to the components of given CRS.
    void
    setSource(org.opengis.referencing.cs.CoordinateSystem cs)
    Sets the source coordinate system to the given value.
    void
    setSource(org.opengis.referencing.cs.EllipsoidalCS cs, org.opengis.referencing.datum.Ellipsoid ellipsoid)
    Deprecated.
    Replaced by setSource(GeodeticCRS).
    void
    setTarget(org.opengis.referencing.crs.GeodeticCRS crs)
    Sets the target coordinate system and related ellipsoid to the components of given CRS.
    void
    setTarget(org.opengis.referencing.cs.CoordinateSystem cs)
    Sets the target coordinate system to the given value.
    void
    setTarget(org.opengis.referencing.cs.EllipsoidalCS cs, org.opengis.referencing.datum.Ellipsoid ellipsoid)
    Deprecated.
    Replaced by setTarget(GeodeticCRS).
    String
    toString()
    Returns a string representation of this context for debugging purposes.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Context

      public Context()
      Creates a new context with all properties initialized to null.

  • Method Details

    • setSource

      public void setSource(org.opengis.referencing.cs.CoordinateSystem cs)
      Sets the source coordinate system to the given value. The source ellipsoid is unconditionally set to null.
      Parameters:
      cs - the coordinate system to set as the source (can be null).

    • setSource

      @Deprecated public void setSource(org.opengis.referencing.cs.EllipsoidalCS cs, org.opengis.referencing.datum.Ellipsoid ellipsoid)
      Deprecated.
      Replaced by setSource(GeodeticCRS).
      Sets the source coordinate system and its associated ellipsoid to the given value.
      Design note: ellipsoidal coordinate systems and ellipsoids are associated indirectly, through a geodetic CRS. However, this method expects those two components to be given explicitly instead of inferring them from a CoordinateReferenceSystem for making clear that MathTransformFactory does not perform any geodetic datum analysis. For coordinate operations that take datum changes in account (including change of prime meridian), see DefaultCoordinateOperationFactory. This policy helps to enforce a separation of concerns.
      Parameters:
      cs - the coordinate system to set as the source, or null.
      ellipsoid - the ellipsoid associated to the given coordinate system, or null.

    • setSource

      public void setSource(org.opengis.referencing.crs.GeodeticCRS crs)
      Sets the source coordinate system and related ellipsoid to the components of given CRS. The Ellipsoid, fetched from the geodetic datum, is often used together with an EllipsoidalCS, but not necessarily. The geodetic CRS may also be associated with a spherical or Cartesian coordinate system, and the ellipsoid information may still be needed even with those non-ellipsoidal coordinate systems.

      This method is not for datum shifts. All datum information other than the ellipsoid are ignored.

      Parameters:
      crs - the coordinate system and ellipsoid to set as the source, or null.
      Since:
      1.3

    • setTarget

      public void setTarget(org.opengis.referencing.cs.CoordinateSystem cs)
      Sets the target coordinate system to the given value. The target ellipsoid is unconditionally set to null.
      Parameters:
      cs - the coordinate system to set as the target (can be null).

    • setTarget

      @Deprecated public void setTarget(org.opengis.referencing.cs.EllipsoidalCS cs, org.opengis.referencing.datum.Ellipsoid ellipsoid)
      Deprecated.
      Replaced by setTarget(GeodeticCRS).
      Sets the target coordinate system and its associated ellipsoid to the given value.
      Design note: see setSource(EllipsoidalCS, Ellipsoid).
      Parameters:
      cs - the coordinate system to set as the source, or null.
      ellipsoid - the ellipsoid associated to the given coordinate system, or null.

    • setTarget

      public void setTarget(org.opengis.referencing.crs.GeodeticCRS crs)
      Sets the target coordinate system and related ellipsoid to the components of given CRS. The Ellipsoid, fetched from the geodetic datum, is often used together with an EllipsoidalCS, but not necessarily. The geodetic CRS may also be associated with a spherical or Cartesian coordinate system, and the ellipsoid information may still be needed even with those non-ellipsoidal coordinate systems.

      This method is not for datum shifts. All datum information other than the ellipsoid are ignored.

      Parameters:
      crs - the coordinate system and ellipsoid to set as the target, or null.
      Since:
      1.3

    • getSourceCS

      public org.opengis.referencing.cs.CoordinateSystem getSourceCS()
      Returns the source coordinate system, or null if unspecified.
      Returns:
      the source coordinate system, or null.

    • getSourceEllipsoid

      public org.opengis.referencing.datum.Ellipsoid getSourceEllipsoid()
      Returns the ellipsoid of the source ellipsoidal coordinate system, or null if it does not apply. This information is valid only if getSourceCS() returns an instance of EllipsoidalCS.
      Returns:
      the ellipsoid of the source ellipsoidal coordinate system, or null if it does not apply.

    • getTargetCS

      public org.opengis.referencing.cs.CoordinateSystem getTargetCS()
      Returns the target coordinate system, or null if unspecified.
      Returns:
      the target coordinate system, or null.

    • getTargetEllipsoid

      public org.opengis.referencing.datum.Ellipsoid getTargetEllipsoid()
      Returns the ellipsoid of the target ellipsoidal coordinate system, or null if it does not apply. This information is valid only if getTargetCS() returns an instance of EllipsoidalCS.
      Returns:
      the ellipsoid of the target ellipsoidal coordinate system, or null if it does not apply.

    • getMatrix

      public org.opengis.referencing.operation.Matrix getMatrix(ContextualParameters.MatrixRole role) throws org.opengis.util.FactoryException
      Returns the matrix that represent the affine transform to concatenate before or after the parameterized transform. The role argument specifies which matrix is desired: This method is invoked by DefaultMathTransformFactory.swapAndScaleAxes(MathTransform, Context). Users an override this method if they need to customize the normalization process.
      Parameters:
      role - whether the normalization or denormalization matrix is desired.
      Returns:
      the requested matrix, or null if this Context has no information about the coordinate system.
      Throws:
      org.opengis.util.FactoryException - if an error occurred while computing the matrix.
      See Also:

    • getMethodUsed

      public org.opengis.referencing.operation.OperationMethod getMethodUsed()
      Returns the operation method used for the math transform creation. This is the same information than DefaultMathTransformFactory.getLastMethodUsed() but more stable (not affected by transforms created with other contexts).
      Returns:
      the operation method used by the factory.
      Throws:
      IllegalStateException - if DefaultMathTransformFactory.createParameterizedTransform(ParameterValueGroup, Context) has not yet been invoked.
      Since:
      1.3
      See Also:

    • getContextualParameters

      public Map<String,Boolean> getContextualParameters()
      Returns the names of parameters that have been inferred from the context. The set of keys can contain any of "dim", "semi_major", "semi_minor", "src_semi_major", "src_semi_minor", "tgt_semi_major", "tgt_semi_minor" and/or "inverse_flattening", depending on the operation method used. The parameters named in that set are included in the parameters returned by getCompletedParameters().

      Associated boolean values

      The associated boolean in the map tells whether the named parameter value is really contextual. The boolean is FALSE if the user explicitly specified a value in the parameters given to the DefaultMathTransformFactory.createParameterizedTransform(ParameterValueGroup, Context) method, and that value is different than the value inferred from the context. Such inconsistencies are also logged at Level.WARNING. In all other cases (no value specified by the user, or a value was specified but is consistent with the context), the associated boolean in the map is TRUE.

      Mutability

      The returned map is modifiable for making easier for callers to amend the contextual information. This map is not used by Context except for information purposes (e.g. in toString()). In particular, modifications of this map have no incidence on the created MathTransform.
      Returns:
      names of parameters inferred from context.
      Since:
      1.3

    • getCompletedParameters

      public org.opengis.parameter.ParameterValueGroup getCompletedParameters()
      Returns the parameter values used for the math transform creation, including the parameters completed by the factory. The parameters inferred from the context are listed by getContextualParameters().
      Returns:
      the parameter values used by the factory.
      Throws:
      IllegalStateException - if DefaultMathTransformFactory.createParameterizedTransform(ParameterValueGroup, Context) has not yet been invoked.

    • toString

      public String toString()
      Returns a string representation of this context for debugging purposes. Current implementation write the name of source/target coordinate systems and ellipsoids. If contextual parameters have already been inferred, then their names are appended with inconsistent parameters (if any) written on a separated line.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this context.