Package net.simplace.pipe.processors
Class LoopParameterProcessor
java.lang.Object
net.simplace.pipe.control.FWProcessor
net.simplace.pipe.control.FWLoopProcessor
net.simplace.pipe.processors.LoopParameterProcessor
Looping processors are running a given Pipeline ${PipeID} several times. The number of loops
is given by the central value (see parameterfilter). 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 map and checks for the regex to check the given parameter
keys, if it should be looped in the given
pipeline. Additionally to Count and runCount you can find the actual looplistentry in
parametername: "${PipeID}.loop",
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Can be overridden to perform semantic checks on the pipeline Input.protected boolean
Can be overridden to perform semantic checks on the pipeline Input.void
boolean
process()
Must be overidden to implemnt 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
-
Constructor Details
-
LoopParameterProcessor
public LoopParameterProcessor()
-
-
Method Details
-
process
Must be overidden to implemnt concrete pipe procedure.- Specified by:
process
in classFWProcessor
- 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 classFWLoopProcessor
- 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 classFWLoopProcessor
- Returns:
- true if not overridden
-
initLoop
- Overrides:
initLoop
in classFWLoopProcessor
-