org.esa.beam.framework.dataop.maptransf
Class TransverseMercatorDescriptor

java.lang.Object
  org.esa.beam.framework.dataop.maptransf.TransverseMercatorDescriptor

All Implemented Interfaces:

MapTransformDescriptor

Deprecated. since BEAM 4.7, use geotools TransverseMercator.Provider instead.

@Deprecated
public class TransverseMercatorDescriptor
extends Object
implements MapTransformDescriptor

The descriptor for a map transformation which implements the Transverse Mercator transformation. The code basis for this transformation has taken from the proj4 map projection API (http://remotesensing.org/proj/).

Version:

$Revision$ $Date$

Author:

Tom Block

Nested Class Summary

class

TransverseMercatorDescriptor.TMT Deprecated. since BEAM 4.7, use geotools MapProjection instead.

Field Summary

static String	MAP_UNIT Deprecated.
static String	NAME Deprecated.
static String[]	PARAMETER_LABELS Deprecated.
static String[]	PARAMETER_NAMES Deprecated.
static String[]	PARAMETER_UNITS Deprecated.
static String	TYPE_ID Deprecated.

Constructor Summary

TransverseMercatorDescriptor()
Deprecated.

Method Summary

MapTransform	createTransform(double[] parameterValues) Deprecated. Creates the associated transform.
String	getMapUnit() Deprecated. Retrieves the unit of this transform.
String	getName() Deprecated. Gets a descriptive name for this map transformation descriptor, e.g.
double[]	getParameterDefaultValues() Deprecated. Gets the default parameter values for this map transform.
Parameter[]	getParameters() Deprecated. Gets the parameter vector for this transform.
MapTransformUI	getTransformUI(MapTransform transform) Deprecated. Gets a user interface for editing the transformation properties of a map projection.
String	getTypeID() Deprecated. Retrieves the type identifier for this transform.
boolean	hasTransformUI() Deprecated. Tests if a user interface is available.
void	registerProjections() Deprecated. This method is called within the MapProjectionRegistry.registerDescriptor(org.esa.beam.framework.dataop.maptransf.MapTransformDescriptor) method after an instance of this MapTransformDescriptor has been successfully registered.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ID

public static final String TYPE_ID

Deprecated.

See Also:

Constant Field Values

NAME

public static final String NAME

Deprecated.

See Also:

Constant Field Values

MAP_UNIT

public static final String MAP_UNIT

Deprecated.

See Also:

Constant Field Values

PARAMETER_NAMES

public static final String[] PARAMETER_NAMES

Deprecated.

PARAMETER_LABELS

public static final String[] PARAMETER_LABELS

Deprecated.

PARAMETER_UNITS

public static final String[] PARAMETER_UNITS

Deprecated.

Constructor Detail

TransverseMercatorDescriptor

public TransverseMercatorDescriptor()

Deprecated.

Method Detail

registerProjections

public void registerProjections()

Deprecated.

This method is called within the MapProjectionRegistry.registerDescriptor(org.esa.beam.framework.dataop.maptransf.MapTransformDescriptor) method after an instance of this MapTransformDescriptor has been successfully registered.

The method delegates the call to UTM.registerProjections() in order to register all frequently used UTM projections.

Specified by:

registerProjections in interface MapTransformDescriptor

getTypeID

public String getTypeID()

Deprecated.

Retrieves the type identifier for this transform.

Specified by:

getTypeID in interface MapTransformDescriptor

Returns:

The unique type identifier for the map transformation, e.g. "Transverse_Mercator".

getName

public String getName()

Deprecated.

Gets a descriptive name for this map transformation descriptor, e.g. "Transverse Mercator".

Specified by:

getName in interface MapTransformDescriptor

Returns:

A descriptive name for this map transformation descriptor, e.g. "Transverse Mercator".

getMapUnit

public String getMapUnit()

Deprecated.

Retrieves the unit of this transform.

Specified by:

getMapUnit in interface MapTransformDescriptor

Returns:

The unit of the map, e.g. "degree" or "meter".

getParameterDefaultValues

public double[] getParameterDefaultValues()

Deprecated.

Gets the default parameter values for this map transform.

Specified by:

getParameterDefaultValues in interface MapTransformDescriptor

Returns:

The default parameter values for this map transform.

getParameters

public Parameter[] getParameters()

Deprecated.

Gets the parameter vector for this transform.

Specified by:

getParameters in interface MapTransformDescriptor

Returns:

The list of parameters required to create a new instance of the map transform.

hasTransformUI

public boolean hasTransformUI()

Deprecated.

Tests if a user interface is available. Returns true because a user interface is available for this descriptor.

Specified by:

hasTransformUI in interface MapTransformDescriptor

Returns:

always true

getTransformUI

public MapTransformUI getTransformUI(MapTransform transform)

Deprecated.

Gets a user interface for editing the transformation properties of a map projection. Never returns null because a user interface is available for this descriptor.

Specified by:

getTransformUI in interface MapTransformDescriptor

Parameters:

transform - the transformation which provides the default properties for the UI.

Returns:

the transformation UI, never null

createTransform

public MapTransform createTransform(double[] parameterValues)

Deprecated.

Creates the associated transform.

Specified by:

createTransform in interface MapTransformDescriptor

Parameters:

parameterValues - the parameters needed by the transform

Returns:

a new instance of a map transform with the array of parameters being copied, never null