net.simplace.util.pipeline.FWProcessor

public static FWProcessor createProcessor(Element aProcessorElement,
FWPipeLinesContainer aContainer) throws PipeLineCreationException;

Creates a processor by dynamically instancing the class given in the JDM element.

• aProcessorElement
• aContainer

returns the created Processor

public static FWProcessor createProcessor(String aClassName)
throws PipeLineCreationException;

Creates a processor by dynamically instancing the class given in the JDM element.

• aClassName

returns the created Processor

public FWProcessor clone(); // Overrides java.lang.Object

Creates a connectlet by dynamically instancing the class given in the JDM element.

public boolean isEndOfPipe();

Sets the end of pipe flag. Pipeline is aborted after this processor.
returns if pipe has ended

public FWObservable pipe(FWObservable aObservabe, Integer
aAllreadyLoopedCount) throws PipeLineException;

Pipes aIncommingObject through this pipe element.

• aObservabe
• aAllreadyLoopedCount

returns the resulting observable

public FWProgressTask getNewProgressTask();


returns the progressTask for given LoopCount (1-n)

public FWProgressTask getProgressTask();


returns the progressTask for integrated LoopCount

public Element toXML();


returns the Element explaining which processor this is

protected void setInitialParameters(Map aInitialParameterMap);

• aInitialParameterMap

protected Map getInitialParameters();


returns the initial parameters of this processor

protected abstract boolean process() throws PipeLineException;

Must be overridden to implement concrete pipe procedure.
returns success

protected boolean checkInParameterMap();

Can be overridden to perform semantic checks on the pipeline Input.
returns true if not overridden by implementations

protected boolean containsParameter(String aSourceKey);

• aSourceKey

returns if the source is contained in In-Parameter set

protected void setEndOfPipeFlag();

Sets the end of pipe flag. Pipe line is aborted after this processor.

protected boolean checkOutParameterMap();

Can be overridden to perform semantic checks on the pipeline Input.
returns true if not overridden

protected Object getInParameter(String aKey);

Returns the value of specified parameter or null if not set.

• aKey

returns the object from the in parameter map

protected FWObservable getInParameters();

Returns the map of all parameters.
returns the in parameter map

protected Object getInParameter(String aKey, Object aDefault);

Returns the value of specified parameter. Returns aDefault if the parameter is null.

• aKey
• aDefault

returns the object from the in parameter map

protected String getStringInParameter(String aKey, String aDefault);

Returns the value of specified key as string. Returns aDefault if the key is null or not a string.

• aKey
• aDefault

returns the object from the in parameter map if it is a string, else the default

protected Map getAllStringInParameters(String aKeyPrefix, boolean
aElimKeyPrefix);

Returns all string in parameters, whose keys start with a given prefix.

• aKeyPrefix prefix the "wanted" parameters must start with
• aElimKeyPrefix if {@code false} the keys of the found parameters are used unchanged for the returned map. If {@code true} the prefix is eliminated for the use in the destination map.

returns an empty map, when {@code aKeyPrefix} is {@code null}

protected String getStringInParameter(String aKey);

Returns the value of specified channel as string. Returns aDefault if the parameter is null or not a string.

• aKey

returns the In parameter as string from observable

protected void setOutParameter(String aKey, Object aValue);

sets a parameter to the output map.

• aKey
• aValue

protected void setInParameterMap(FWObservable aObservable);

• aObservable

protected Object getOutParameter(String aKey);

gets a parameter from the output map.

• aKey

returns

protected Set getOutParameterKeys();

gets a keySet of parameters in the output map.
returns out parameter keys

protected void removeOutParameter(String aElement);

removes a Parameter form Map

• aElement of OutParameterMap

protected Element getConfiguration();

gets the detailed configuration of the Processor.
returns the processors configration element

protected void setConfiguration(String aClassname, Element
aConfigurationElement);

sets the detailed configuration of a Processor.

• aClassname
• aConfigurationElement

protected boolean hasConfiguration();

gets the detailed configuration of the Processor.
returns if has additional configuration

protected void fireTaskEvent(JPanel aSourcePanel);

fires TaskEvent to listening Panels.

• aSourcePanel

protected FWPipeLine getPipeLine(String aPipeLineID);

• aPipeLineID

returns the the count of loops, invoked by this processor

protected String getSystemID();


returns the SystemID from PipelineContainer

protected void setStateProgressing(int aPercentDone, String aMessage);

• aPercentDone
• aMessage
• the statusOfTask is set to progressing. percentDone (0-100).

protected void setStateOfTask(String aStatusOfTask);

• aStatusOfTask the statusOfTask to set - use Variables in class State

protected void setLoopedCount(int aNumberOfAllreadyLooped);

• aNumberOfAllreadyLooped
• aLoopedCount - has to be set from the looping processor because of thread safety