org.esa.beam.framework.dataop.maptransf

Class AlbersEqualAreaConicDescriptor

java.lang.Object

org.esa.beam.framework.dataop.maptransf.AlbersEqualAreaConicDescriptor

All Implemented Interfaces:

MapTransformDescriptor

Deprecated.

since BEAM 4.7, use geotools AlbersEqualArea.Provider instead.

@Deprecated
public class AlbersEqualAreaConicDescriptor
extends Object
implements MapTransformDescriptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AlbersEqualAreaConicDescriptor.AEAC Deprecated. since BEAM 4.7, use geotools MapProjection instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAP_UNIT Deprecated. The map unit of this map descriptor
static String	NAME Deprecated. The name of this map descriptor
static double[]	PARAMETER_DEFAULT_VALUES Deprecated. The default parameters of this map descriptor NOTE: These default values are specific to the SIBERIA-II project and should be altered accordingly for other areas of interest.
static String[]	PARAMETER_LABELS Deprecated.
static String[]	PARAMETER_NAMES Deprecated.
static String[]	PARAMETER_UNITS Deprecated.
static String	TYPE_ID Deprecated. The type ID of this map descriptor

Constructor Summary

Constructors

Constructor and Description
AlbersEqualAreaConicDescriptor() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
MapTransform	createTransform(double[] parameterValues) Deprecated. Creates an instance of the map transform for the given parameter values.
String	getMapUnit() Deprecated. Gets the unit of the map.
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 list of parameters required to create an instance of the map transform.
MapTransformUI	getTransformUI(MapTransform transform) Deprecated. Gets a user interface for editing the transformation properties of a map projection.
String	getTypeID() Deprecated. Gets the unique type identifier for the map transformation, e.g.
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.

The type ID of this map descriptor

See Also:

Constant Field Values

NAME

public static final String NAME

Deprecated.

The name of this map descriptor

See Also:

Constant Field Values

MAP_UNIT

public static final String MAP_UNIT

Deprecated.

The map unit of this map descriptor

See Also:

Constant Field Values

PARAMETER_NAMES

public static final String[] PARAMETER_NAMES

Deprecated.

PARAMETER_DEFAULT_VALUES

public static final double[] PARAMETER_DEFAULT_VALUES

Deprecated.

The default parameters of this map descriptor

NOTE: These default values are specific to the SIBERIA-II project and should be altered accordingly for other areas of interest.

PARAMETER_LABELS

public static final String[] PARAMETER_LABELS

Deprecated.

PARAMETER_UNITS

public static final String[] PARAMETER_UNITS

Deprecated.

Constructor Detail

AlbersEqualAreaConicDescriptor

public AlbersEqualAreaConicDescriptor()

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 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

getTypeID

public String getTypeID()

Deprecated.

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

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.

Specified by:

getName in interface MapTransformDescriptor

Returns:

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

See Also:

NAME

getMapUnit

public String getMapUnit()

Deprecated.

Gets the unit of the map.

Specified by:

getMapUnit in interface MapTransformDescriptor

Returns:

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

getParameters

public Parameter[] getParameters()

Deprecated.

Gets the list of parameters required to create an instance of the map transform.

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 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 an instance of the map transform for the given parameter values.

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