Package net.simplace.pipe.processors

Class MathCalculatorProcessor

java.lang.Object

net.simplace.pipe.control.FWProcessor

net.simplace.pipe.processors.MathCalculatorProcessor

public class MathCalculatorProcessor
extends FWProcessor

This processor is there for easy math calulations within maps, numbers, lists aso. If a Map is evaluated, this has to be #0 in the parameter list and is taken as base of output. Same for Lists.
Required input parameters:

• Key #0, #1, ...: References-key to @link Map, List, Integer, Double, Long}-object. Several of these parameters are allowed.
• Key rule: arithmetical rule on raster data with wildcards '#0', '#1' ... for the raster objects in the list. See OperationTreeParser for details about the syntax and allowed operators.
• Key resultParamKey: Output parameter key where the result data is stored in

Author:

Andreas Enders

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESULTKEY_KEY	Constant for in channel parameter key "resultParamKey".
static final String	RULE_KEY	Constant for in-channel parameter key "rule".
static final String	TYPE_DOUBLE	Constant for input type "Double".
static final String	TYPE_INTEGER	Constant for input type "Integer".
static final String	TYPE_KEY	Constant for in-channel parameter key "type".
static final String	TYPE_LIST	Constant for input type "List".
static final String	TYPE_LONG	Constant for input type "Long".
static final String	TYPE_MAP	Constant for input type "Map".

Fields inherited from class net.simplace.pipe.control.FWProcessor

iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks

Constructor Summary

Constructors

Constructor	Description
MathCalculatorProcessor()	Default constructor for this processor.

Method Summary

Modifier and Type	Method	Description
boolean	checkInParameterMap()	Checks whether the in-channel contains all required parameters.
protected boolean	process()	Calculated the arithmetical rule specified by the in-channel parameters.

Methods inherited from class net.simplace.pipe.control.FWProcessor

checkOutParameterMap, clone, containsParameter, createProcessor, createProcessor, fireTaskEvent, getAllStringInParameters, getConfiguration, getInitialParameters, getInParameter, getInParameter, getInParameters, getNewProgressTask, getOutParameter, getOutParameterKeys, getPipeLine, getProgressTask, getStringInParameter, getStringInParameter, getSystemID, hasConfiguration, isEndOfPipe, pipe, removeOutParameter, setConfiguration, setEndOfPipeFlag, setInitialParameters, setInParameterMap, setLoopedCount, setOutParameter, setStateOfTask, setStateProgressing, toXML

Methods inherited from class java.lang.Object

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

Field Details

TYPE_KEY

public static final String TYPE_KEY

Constant for in-channel parameter key "type".

See Also:

• Constant Field Values

TYPE_MAP

public static final String TYPE_MAP

Constant for input type "Map".

See Also:

• Constant Field Values

TYPE_LIST

public static final String TYPE_LIST

Constant for input type "List".

See Also:

• Constant Field Values

TYPE_INTEGER

public static final String TYPE_INTEGER

Constant for input type "Integer".

See Also:

• Constant Field Values

TYPE_LONG

public static final String TYPE_LONG

Constant for input type "Long".

See Also:

• Constant Field Values

TYPE_DOUBLE

public static final String TYPE_DOUBLE

Constant for input type "Double".

See Also:

• Constant Field Values

RULE_KEY

public static final String RULE_KEY

Constant for in-channel parameter key "rule".

See Also:

• Constant Field Values

RESULTKEY_KEY

public static final String RESULTKEY_KEY

Constant for in channel parameter key "resultParamKey".

See Also:

• Constant Field Values

Constructor Details

MathCalculatorProcessor

public MathCalculatorProcessor()

Default constructor for this processor.

Method Details

checkInParameterMap

public boolean checkInParameterMap()

Checks whether the in-channel contains all required parameters.

Overrides:

checkInParameterMap in class FWProcessor

Returns:

true if not overridden by implementations

process

protected boolean process()
                   throws PipeLineException

Calculated the arithmetical rule specified by the in-channel parameters. First all in-channel parameters are checked.

Specified by:

process in class FWProcessor

Returns:

ever true

Throws:

PipeLineException - in case of errors

See Also:

• checkInParameterMap()