org.esa.beam.framework.gpf.ui
Class OperatorParameterSupport

java.lang.Object
  org.esa.beam.framework.gpf.ui.OperatorParameterSupport

public class OperatorParameterSupport
extends Object

WARNING: This class belongs to a preliminary API and may change in future releases. Support for operator parameters input/output.

Author:

Norman Fomferra, Marco Zühlke

Constructor Summary

OperatorParameterSupport(Class<? extends Operator> opType)
Creates a parameter support for the given operator type.

OperatorParameterSupport(Class<? extends Operator> opType, com.bc.ceres.binding.PropertySet propertySet, Map<String,Object> parameterMap, ParameterUpdater parameterUpdater)
Creates a parameter support, for the given operator type.

Method Summary

void	fromDomElement(com.bc.ceres.binding.dom.DomElement parametersElement)
Map<String,Object>	getParameterMap()
com.bc.ceres.binding.PropertySet	getPopertySet()
com.bc.ceres.binding.dom.DomElement	toDomElement()

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorParameterSupport

public OperatorParameterSupport(Class<? extends Operator> opType)

Creates a parameter support for the given operator type.

Parameters:

opType - The operator type.

OperatorParameterSupport

public OperatorParameterSupport(Class<? extends Operator> opType,
                                com.bc.ceres.binding.PropertySet propertySet,
                                Map<String,Object> parameterMap,
                                ParameterUpdater parameterUpdater)

Creates a parameter support, for the given operator type.

If a property set and a parameter map are given the client as to keep them in sync. The parameterUpdater will be called before each save and after each load request to enable custom updating.

Parameters:

opType - The operator type (mandatory).

propertySet - The property set (can be null). If supplied a parameter map is required as well.

parameterMap - the parameter map (can be null)

parameterUpdater - The parameter updater (can be null)

Method Detail

getPopertySet

public com.bc.ceres.binding.PropertySet getPopertySet()

getParameterMap

public Map<String,Object> getParameterMap()

fromDomElement

public void fromDomElement(com.bc.ceres.binding.dom.DomElement parametersElement)
                    throws com.bc.ceres.binding.ValidationException,
                           com.bc.ceres.binding.ConversionException

Throws:

com.bc.ceres.binding.ValidationException

com.bc.ceres.binding.ConversionException

toDomElement

public com.bc.ceres.binding.dom.DomElement toDomElement()
                                                 throws com.bc.ceres.binding.ValidationException,
                                                        com.bc.ceres.binding.ConversionException

Throws:

com.bc.ceres.binding.ValidationException

com.bc.ceres.binding.ConversionException