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

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

All Implemented Interfaces:

MapTransformDescriptor

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

@Deprecated
public class IdentityTransformDescriptor
extends Object
implements MapTransformDescriptor

The descriptor for a map transformation which represents the identity transformation.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Field Summary

static String	MAP_UNIT Deprecated.
static String	NAME Deprecated.
static double[]	PARAMETER_DEFAULT_VALUES Deprecated.
static Parameter[]	PARAMETERS Deprecated.
static String	TYPE_ID Deprecated.

Constructor Summary

IdentityTransformDescriptor()
Deprecated.

Method Summary

MapTransform	createTransform(double[] parameterValues) Deprecated. Creates an instance of the map transform for the given parameter values.
String	getMapUnit() Deprecated.
String	getName() Deprecated. Gets a descriptive name for this map transformation descriptor.
double[]	getParameterDefaultValues() Deprecated. Gets the default parameter values for this map transform.
Parameter[]	getParameters() Deprecated. Gets the parameters for this map transform.
MapTransformUI	getTransformUI(MapTransform transform) Deprecated. Gets a user interface for editing the transformation properties of a map projection.
String	getTypeID() Deprecated.
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

PARAMETERS

public static final Parameter[] PARAMETERS

Deprecated.

PARAMETER_DEFAULT_VALUES

public static final double[] PARAMETER_DEFAULT_VALUES

Deprecated.

Constructor Detail

IdentityTransformDescriptor

public IdentityTransformDescriptor()

Deprecated.

Method Detail

registerProjections

public void registerProjections()

Deprecated.

Description copied from interface: MapTransformDescriptor

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 can and should be used to register projections that are based on the type of MapTransform described by this MapTransformDescriptor. Registering projection instances is done using the using the MapProjectionRegistry.registerProjection(org.esa.beam.framework.dataop.maptransf.MapProjection) method.

A typical implementation of this method would be:

 public void registerProjections() {
     MapProjectionRegistry.registerProjection(new MapProjection("my-projection-name-1", new
 MyMapTransform(param_1)));
     MapProjectionRegistry.registerProjection(new MapProjection("my-projection-name-2", new
 MyMapTransform(param_2)));
     MapProjectionRegistry.registerProjection(new MapProjection("my-projection-name-3", new
 MyMapTransform(param_3)));
     ...
 }
 

Specified by:

registerProjections in interface MapTransformDescriptor

getName

public String getName()

Deprecated.

Gets a descriptive name for this map transformation descriptor.

Specified by:

getName in interface MapTransformDescriptor

Returns:

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

getTypeID

public String getTypeID()

Deprecated.

Specified by:

getTypeID in interface MapTransformDescriptor

Returns:

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

getMapUnit

public String getMapUnit()

Deprecated.

Specified by:

getMapUnit in interface MapTransformDescriptor

Returns:

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

getParameters

public Parameter[] getParameters()

Deprecated.

Description copied from interface: MapTransformDescriptor

Gets the parameters for this map transform.

Important: Changing elements in the returned array may change this object's state.

Specified by:

getParameters in interface MapTransformDescriptor

Returns:

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

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.

hasTransformUI

public boolean hasTransformUI()

Deprecated.

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

Specified by:

hasTransformUI in interface MapTransformDescriptor

Returns:

always false

getTransformUI

public MapTransformUI getTransformUI(MapTransform transform)

Deprecated.

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

Specified by:

getTransformUI in interface MapTransformDescriptor

Parameters:

transform - ignored

Returns:

always null

createTransform

public MapTransform createTransform(double[] parameterValues)

Deprecated.

Description copied from interface: MapTransformDescriptor

Creates an instance of the map transform for the given parameter values. The parameter value array must exactly match the size and semantics of the parameters returned by the MapTransformDescriptor.getParameters() method.

Important: Implementors of this method shall ensure that an element-wise copy of the given parameter array is created and set.

Specified by:

createTransform in interface MapTransformDescriptor

Parameters:

parameterValues - the parameter values. If null, a map transform with default parameter values is created

Returns:

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