org.hkijena.jipipe.plugins.utils.algorithms.processes

Class RunProcessIteratingAlgorithm

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.nodes.algorithm.JIPipeParameterSlotAlgorithm

org.hkijena.jipipe.api.nodes.algorithm.JIPipeIteratingAlgorithm

org.hkijena.jipipe.plugins.utils.algorithms.processes.RunProcessIteratingAlgorithm

All Implemented Interfaces:

JIPipeSlotConfiguration.SlotConfigurationChangedEventListener, JIPipeFunctionallyComparable, JIPipeIterationStepAlgorithm, JIPipeAdaptiveParametersAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

public class RunProcessIteratingAlgorithm
extends JIPipeIteratingAlgorithm

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.nodes.JIPipeGraphNode

JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.BaseDirectoryChangedEventEmitter, JIPipeGraphNode.BaseDirectoryChangedEventListener, JIPipeGraphNode.NodeSlotsChangedEvent, JIPipeGraphNode.NodeSlotsChangedEventEmitter, JIPipeGraphNode.NodeSlotsChangedEventListener, JIPipeGraphNode.Serializer

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Field Summary

Fields inherited from class org.hkijena.jipipe.api.nodes.algorithm.JIPipeParameterSlotAlgorithm

SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
RunProcessIteratingAlgorithm(JIPipeNodeInfo info)
RunProcessIteratingAlgorithm(RunProcessIteratingAlgorithm other)

Method Summary

Modifier and Type	Method and Description
OptionalJIPipeExpressionParameter	getOverrideArguments()
ProcessEnvironment	getProcessEnvironment()
boolean	isCleanUpAfterwards()
boolean	isOutputOutputFolder()
protected void	runIteration(JIPipeSingleIterationStep iterationStep, JIPipeIterationContext iterationContext, JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setCleanUpAfterwards(boolean cleanUpAfterwards)
void	setOutputOutputFolder(boolean outputOutputFolder)
void	setOverrideArguments(OptionalJIPipeExpressionParameter overrideArguments)
void	setProcessEnvironment(ProcessEnvironment processEnvironment)

Methods inherited from class org.hkijena.jipipe.api.nodes.algorithm.JIPipeIteratingAlgorithm

createUIInputSlotIconDescriptionMenuItems, generateDataBatchesGenerationResult, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getParallelizationBatchSize, isAllowEmptyIterationStep, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, supportsParallelization

Methods inherited from class org.hkijena.jipipe.api.nodes.algorithm.JIPipeParameterSlotAlgorithm

getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, onParameterChanged, run

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

canAutoPassThrough, canPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isPassThrough, isPostprocessor, isPreprocessor, isSkipped, loadExample, onDeserialized, reportValidity, runPassThrough, setEnabled, setPassThrough, setRuntimePartition, setSkipped

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeGraphNode

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDependencies, getDisplayName, getEnvironmentDependencies, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getName, getNewScratch, getNodeSlotsChangedEventEmitter, getNodeUILocationPerViewModePerCompartment, getNodeUILocationWithin, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProject, getProjectCompartment, getProjectDataDirs, getProjectDirectory, getRuntimeProject, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getTextDescription, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onSlotConfigurationChanged, renderInputSlots, renderOutputSlots, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setNodeUILocationPerViewModePerCompartment, setNodeUILocationWithin, setNodeUILocationWithin, setParentGraph, setProjectDirectory, setRuntimeProject, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, setUiLocked, toggleSlot, toJson, updateGraphNodeSlots

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.nodes.iterationstep.JIPipeIterationStepAlgorithm

generateDataBatchesDryRun

Methods inherited from interface org.hkijena.jipipe.api.nodes.JIPipeAdaptiveParametersAlgorithm

installUIOverrideParameterEditor, installUIParameterOptions

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection.ParameterUIChangedEventListener

onParameterUIChanged

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection.ParameterStructureChangedEventListener

onParameterStructureChanged

Constructor Detail

RunProcessIteratingAlgorithm

public RunProcessIteratingAlgorithm(JIPipeNodeInfo info)

RunProcessIteratingAlgorithm

public RunProcessIteratingAlgorithm(RunProcessIteratingAlgorithm other)

Method Detail

runIteration

protected void runIteration(JIPipeSingleIterationStep iterationStep,
                            JIPipeIterationContext iterationContext,
                            JIPipeGraphNodeRunContext runContext,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeIteratingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeIteratingAlgorithm

Parameters:

iterationStep - The data interface

iterationContext - The iteration context

runContext - the run context

progressInfo - the progress info from the run

getProcessEnvironment

public ProcessEnvironment getProcessEnvironment()

setProcessEnvironment

public void setProcessEnvironment(ProcessEnvironment processEnvironment)

getOverrideArguments

public OptionalJIPipeExpressionParameter getOverrideArguments()

setOverrideArguments

public void setOverrideArguments(OptionalJIPipeExpressionParameter overrideArguments)

isOutputOutputFolder

public boolean isOutputOutputFolder()

setOutputOutputFolder

public void setOutputOutputFolder(boolean outputOutputFolder)

isCleanUpAfterwards

public boolean isCleanUpAfterwards()

setCleanUpAfterwards

public void setCleanUpAfterwards(boolean cleanUpAfterwards)