Package net.simplace.pipe.processors

Class FilterParameterProcessor

java.lang.Object

net.simplace.pipe.control.FWProcessor

net.simplace.pipe.processors.FilterParameterProcessor

public class FilterParameterProcessor
extends FWProcessor

This processor filters the parameters in Map. It is used to free memory for example at pipeline Required input parameters:

• Key #0, #1, ...: References-key to Parameter key-object. Several of these parameters are allowed.
• Key type: taking Values as DELETE or KEEP: KEEP keeps only in '#0' ... mentioned parameters, DELETE deletes only '#0', '#1' ... mentioned parameters.

System parameters are excluded from deleting (_TEMPDIR_, delete_temp_at_end, ...)

Version:

1.0

Author:

Andreas Enders

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	PARAM_TO_KEEP	Constant Array of Parameters to Keep
static final String	TYPE_DELETE	Constant for input type "Map".
static final String	TYPE_KEEP	Constant for input type "List".
static final String	TYPE_KEY	Constant for in-channel parameter key "type".

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

iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks

Constructor Summary

Constructors

Constructor	Description
FilterParameterProcessor()	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()	Deletes parameters that are not protected and mentioned in 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_DELETE

public static final String TYPE_DELETE

Constant for input type "Map".

See Also:

• Constant Field Values

TYPE_KEEP

public static final String TYPE_KEEP

Constant for input type "List".

See Also:

• Constant Field Values

PARAM_TO_KEEP

public static final List<String> PARAM_TO_KEEP

Constant Array of Parameters to Keep

Constructor Details

FilterParameterProcessor

public FilterParameterProcessor()

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

Deletes parameters that are not protected and mentioned in parameters.

Specified by:

process in class FWProcessor

Returns:

ever true

Throws:

PipeLineException - in case of errors

See Also:

• checkInParameterMap()