Package net.simplace.pipe.processors

Class LoopListProcessor

java.lang.Object

net.simplace.pipe.control.FWProcessor

net.simplace.pipe.control.FWLoopProcessor

net.simplace.pipe.processors.LoopListProcessor

public final class LoopListProcessor
extends FWLoopProcessor

Looping processors are running a given Pipeline ${PipeID} several times. The number of loops is given by the central value (see parameterlist). Loops are separated by default (${separateLoops} (TRUE|FALSE)). For non separated loops all parameter values created in the pipeline process are written to parameter map. Within the looped pipeline you can finde the total run count ${runCount} and the run count ${Count} This looping processor takes the parameter in ${looplist} converted ot list or map to loop the pipeline. Additionally to Count and runCount you can find the actual looplistentry in parametername: "${looplist}.loop", for maps the actual looplistvalue in parametername: "${looplist}.loopvalue" as a special the looplist can be a String too. Format: comma-separated for lists: "first,next,last" or Format: comma-separated with = and leading and ending brace for maps: "{first=firstvalue,next=nextvalue,last=lastvalue} further parameter: ${startIndex} gives the first index of ${Count}-Parameter in looping pipeline.

Author:

Andreas Enders

Field Summary

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

iLoopCount, iLoopMap, iLoopPipeId, iSeparateRuns

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

iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks

Constructor Summary

Constructors

Constructor	Description
LoopListProcessor()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkInParameterMap()	Can be overridden to perform semantic checks on the pipeline Input.
protected boolean	checkOutParameterMap()	Can be overridden to perform semantic checks on the pipeline Input.
void	initLoop(Map<String,Object> aParameterMap)
boolean	process()	Must be overridden to implement concrete pipe procedure.

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

clone, getLoopCount, getLoopMap, getLoopPipeID, interveneRunLoop, runLoop

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

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

Constructor Details

LoopListProcessor

public LoopListProcessor()

Method Details

process

public boolean process()
                throws PipeLineException

Must be overridden to implement concrete pipe procedure.

Specified by:

process in class FWProcessor

Returns:

success

Throws:

PipeLineException

checkInParameterMap

protected boolean checkInParameterMap()

Description copied from class: FWProcessor

Can be overridden to perform semantic checks on the pipeline Input.

Overrides:

checkInParameterMap in class FWLoopProcessor

Returns:

true if not overridden by implementations

checkOutParameterMap

protected boolean checkOutParameterMap()

Description copied from class: FWProcessor

Can be overridden to perform semantic checks on the pipeline Input.

Overrides:

checkOutParameterMap in class FWLoopProcessor

Returns:

true if not overridden

initLoop

public void initLoop(Map<String,Object> aParameterMap)

Overrides:

initLoop in class FWLoopProcessor