org.geotools.ct
Class MathTransformProvider

java.lang.Object
  org.geotools.ct.MathTransformProvider

Direct Known Subclasses:

Provider

Deprecated. Replaced by MathTransformProvider in the org.geotools.referencing.operation package.

public abstract class MathTransformProvider

extends java.lang.Object

Base class for MathTransform providers. Instance of this class allow the creation of transform objects from a classification name.

Note: this class is not part of OpenGIS specification and may change in a future version. Do not rely strongly on it.

Version:

$Id: MathTransformProvider.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

Field Summary

static javax.media.jai.ParameterListDescriptor	DEFAULT_PROJECTION_DESCRIPTOR Deprecated. A default parameter list descriptor for map projections.
protected static javax.media.jai.util.Range	LATITUDE_RANGE Deprecated. Range of latitude values.
protected static javax.media.jai.util.Range	LONGITUDE_RANGE Deprecated. Range of longitude values.
protected static javax.media.jai.util.Range	POSITIVE_RANGE Deprecated. Range of positives values.

Constructor Summary

protected

MathTransformProvider(java.lang.String classification, javax.media.jai.ParameterListDescriptor inherit) Deprecated. Construct a new provider.

Method Summary

abstract MathTransform	create(javax.media.jai.ParameterList parameters) Deprecated. Returns a transform for the specified parameters.
protected MathTransform	create(Projection projection) Deprecated. Returns a transform for the specified projection.
java.lang.String	getClassName() Deprecated. Returns the classification name.
java.lang.String	getName(java.util.Locale locale) Deprecated. Returns a human readable name localized for the specified locale.
javax.media.jai.ParameterList	getParameterList() Deprecated. Returns a newly created parameter list.
javax.media.jai.ParameterListDescriptor	getParameterListDescriptor() Deprecated. Returns the parameter list descriptor.
protected void	put(java.lang.String parameter, double defaultValue, javax.media.jai.util.Range range) Deprecated. Adds or changes a parameter to this math transform provider.
protected void	remove(java.lang.String parameter) Deprecated. Remove a parameter from this math transform provider.
java.lang.String	toString() Deprecated. Returns a string representation for this provider.

Methods inherited from class java.lang.Object

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

Field Detail

POSITIVE_RANGE

protected static final javax.media.jai.util.Range POSITIVE_RANGE

Deprecated.

Range of positives values. Range goes from 0 exclusive to positive infinity.

LONGITUDE_RANGE

protected static final javax.media.jai.util.Range LONGITUDE_RANGE

Deprecated.

Range of longitude values. Range goes from -180? to +180? inclusives.

LATITUDE_RANGE

protected static final javax.media.jai.util.Range LATITUDE_RANGE

Deprecated.

Range of latitude values. Range goes from -90? to +90? inclusives.

DEFAULT_PROJECTION_DESCRIPTOR

public static final javax.media.jai.ParameterListDescriptor DEFAULT_PROJECTION_DESCRIPTOR

Deprecated.

A default parameter list descriptor for map projections. This descriptor declare "semi_major", "semi_minor", "central_meridian", "latitude_of_origin", "scale_factor", "false_easting" and "false_northing" parameters.

Constructor Detail

MathTransformProvider

protected MathTransformProvider(java.lang.String classification,
                                javax.media.jai.ParameterListDescriptor inherit)

Deprecated.

Construct a new provider.

Parameters:

classification - The classification name.

inherit - The parameter list descriptor to inherit from, or null if there is none. All parameter descriptions from inherit will be copied into this newly created MathTransformProvider. For map projections, this argument may be DEFAULT_PROJECTION_DESCRIPTOR. Subclasses may add or change parameters in their constructor by invoking put(java.lang.String, double, javax.media.jai.util.Range).

Method Detail

put

protected final void put(java.lang.String parameter,
                         double defaultValue,
                         javax.media.jai.util.Range range)
                  throws java.lang.IllegalStateException

Deprecated.

Adds or changes a parameter to this math transform provider. If this MathTransformProvider has been constructed with DEFAULT_PROJECTION_DESCRIPTOR as argument, then default values are already provided for "semi_major", "semi_minor", "central_meridian", "latitude_of_origin", "scale_factor", "false_easting" and "false_northing". Subclasses may call this method in their constructor for adding or changing parameters.

Parameters:

parameter - The parameter name.

defaultValue - The default value for this parameter, or Double.NaN if there is none.

range - The range of legal values. May be one of the predefined constants (POSITIVE_RANGE, LONGITUDE_RANGE, LATITUDE_RANGE) or any other Range object. May be null if all values are valid for this parameter.

Throws:

java.lang.IllegalStateException - If getParameterList() has already been invoked prior to this call.

remove

protected final void remove(java.lang.String parameter)
                     throws java.lang.IllegalStateException

Deprecated.

Remove a parameter from this math transform provider.

Parameters:

parameter - The parameter name to remove.

Throws:

java.lang.IllegalStateException - If getParameterList() has already been invoked prior to this call.

getClassName

public java.lang.String getClassName()

Deprecated.

Returns the classification name.

getName

public java.lang.String getName(java.util.Locale locale)

Deprecated.

Returns a human readable name localized for the specified locale. If no name is available for the specified locale, this method may returns a name in an arbitrary locale.

getParameterListDescriptor

public javax.media.jai.ParameterListDescriptor getParameterListDescriptor()

Deprecated.

Returns the parameter list descriptor. The default implementation build the descriptor from the parameters specified by the constructor with put(java.lang.String, double, javax.media.jai.util.Range).

getParameterList

public javax.media.jai.ParameterList getParameterList()

Deprecated.

Returns a newly created parameter list. The set of parameter depend of the transform this provider is for. Parameters may have default values and a range of validity.

create

public abstract MathTransform create(javax.media.jai.ParameterList parameters)
                              throws MissingParameterException,
                                     org.opengis.referencing.FactoryException

Deprecated.

Returns a transform for the specified parameters.

Parameters:

parameters - The parameter values in standard units.

Returns:

A MathTransform object of this classification.

Throws:

MissingParameterException - if a mandatory parameter is missing.

org.opengis.referencing.FactoryException - if the transform can't be created.

create

protected MathTransform create(Projection projection)
                        throws MissingParameterException,
                               org.opengis.referencing.FactoryException

Deprecated.

Returns a transform for the specified projection. The default implementation invokes create(ParameterList) with the projection's parameters.

Parameters:

projection - The projection.

Returns:

A MathTransform object of this classification.

Throws:

MissingParameterException - if a mandatory parameter is missing.

org.opengis.referencing.FactoryException - if the transform can't be created for some other reason.

toString

public java.lang.String toString()

Deprecated.

Returns a string representation for this provider.