org.hkijena.jipipe.api.grouping

Class JIPipeGraphWrapperAlgorithm

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.grouping.JIPipeGraphWrapperAlgorithm

All Implemented Interfaces:

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

Direct Known Subclasses:

JIPipeNodeGroup, JsonAlgorithm

public class JIPipeGraphWrapperAlgorithm
extends JIPipeAlgorithm
implements JIPipeIterationStepAlgorithm

An algorithm that wraps another algorithm graph

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeGraphWrapperAlgorithm.IterationMode Determines how the data is iterated
static class	JIPipeGraphWrapperAlgorithm.IterationModeEnumInfo

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

Constructor Summary

Constructors

Constructor and Description
JIPipeGraphWrapperAlgorithm(JIPipeGraphWrapperAlgorithm other) Copies the algorithm
JIPipeGraphWrapperAlgorithm(JIPipeNodeInfo info, JIPipeGraph wrappedGraph)

Method Summary

Modifier and Type	Method and Description
JIPipeDataBatchGenerationResult	generateDataBatchesGenerationResult(List<JIPipeInputDataSlot> slots, JIPipeProgressInfo progressInfo) Generates iteration steps.
JIPipeMergingAlgorithmIterationStepGenerationSettings	getBatchGenerationSettings()
JIPipeGraphRunPartitionInheritedBoolean	getContinueOnFailure()
JIPipeGraphRunPartitionInheritedBoolean	getContinueOnFailureExportFailedInputs()
Set<JIPipeDependency>	getDependencies() Returns a list of all dependencies this algorithm currently has.
JIPipeIterationStepGenerationSettings	getGenerationSettingsInterface() Returns the batch generation settings as interface
GraphWrapperAlgorithmInput	getGroupInput() Gets the graphs' input node
GraphWrapperAlgorithmOutput	getGroupOutput() Gets the graphs' output node
JIPipeGraphWrapperAlgorithm.IterationMode	getIterationMode()
JIPipeGraph	getWrappedGraph()
JIPipeGraphRunPartitionInheritedBoolean	isContinueOnFailure()
boolean	isPreventUpdateSlots()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setBatchGenerationSettings(JIPipeMergingAlgorithmIterationStepGenerationSettings batchGenerationSettings)
void	setContinueOnFailure(JIPipeGraphRunPartitionInheritedBoolean continueOnFailure)
void	setContinueOnFailureExportFailedInputs(JIPipeGraphRunPartitionInheritedBoolean continueOnFailureExportFailedInputs)
void	setInternalStoragePath(Path internalStoragePath) Sets the internal storage path relative to the output folder.
void	setIterationMode(JIPipeGraphWrapperAlgorithm.IterationMode iterationMode)
void	setPreventUpdateSlots(boolean preventUpdateSlots)
void	setProjectDirectory(Path projectDirectory) Sets the project directory.
void	setRuntimeProject(JIPipeProject runtimeProject) Sets the current project associated with the current run
void	setScratchBaseDirectory(Path scratchBaseDirectory) Sets the scratch base directory of the current run.
void	setWrappedGraph(JIPipeGraph wrappedGraph)
void	updateGroupSlots() Updates the slots from the wrapped graph

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

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

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

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, createUIInputSlotIconDescriptionMenuItems, duplicate, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDataInputSlots, getDisplayName, getEnvironmentDependencies, getFirstInputSlot, 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, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onParameterChanged, onSlotConfigurationChanged, renderInputSlots, renderOutputSlots, setBookmarked, setCustomDescription, setCustomName, setInfo, setNodeUILocationPerViewModePerCompartment, setNodeUILocationWithin, setNodeUILocationWithin, setParentGraph, 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.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

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

JIPipeGraphWrapperAlgorithm

public JIPipeGraphWrapperAlgorithm(JIPipeNodeInfo info,
                                   JIPipeGraph wrappedGraph)

Parameters:

info - the info

wrappedGraph - the graph wrapper

JIPipeGraphWrapperAlgorithm

public JIPipeGraphWrapperAlgorithm(JIPipeGraphWrapperAlgorithm other)

Copies the algorithm

Parameters:

other - the original

Method Detail

updateGroupSlots

public void updateGroupSlots()

Updates the slots from the wrapped graph

getContinueOnFailureExportFailedInputs

public JIPipeGraphRunPartitionInheritedBoolean getContinueOnFailureExportFailedInputs()

setContinueOnFailureExportFailedInputs

public void setContinueOnFailureExportFailedInputs(JIPipeGraphRunPartitionInheritedBoolean continueOnFailureExportFailedInputs)

isPreventUpdateSlots

public boolean isPreventUpdateSlots()

setPreventUpdateSlots

public void setPreventUpdateSlots(boolean preventUpdateSlots)

isContinueOnFailure

public JIPipeGraphRunPartitionInheritedBoolean isContinueOnFailure()

getContinueOnFailure

public JIPipeGraphRunPartitionInheritedBoolean getContinueOnFailure()

setContinueOnFailure

public void setContinueOnFailure(JIPipeGraphRunPartitionInheritedBoolean continueOnFailure)

getGroupInput

public GraphWrapperAlgorithmInput getGroupInput()

Gets the graphs' input node

Returns:

the graphs' input node

getGroupOutput

public GraphWrapperAlgorithmOutput getGroupOutput()

Gets the graphs' output node

Returns:

the graph's output node

run

public void run(JIPipeGraphNodeRunContext runContext,
                JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Overrides:

run in class JIPipeAlgorithm

Parameters:

runContext - the context of the run process

progressInfo - progress passed from the runner

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeAlgorithm

Parameters:

reportContext - the report context

report - the report to be added to

getDependencies

public Set<JIPipeDependency> getDependencies()

Description copied from class: JIPipeGraphNode

Returns a list of all dependencies this algorithm currently has.

Overrides:

getDependencies in class JIPipeGraphNode

Returns:

set of dependencies

getWrappedGraph

public JIPipeGraph getWrappedGraph()

setWrappedGraph

public void setWrappedGraph(JIPipeGraph wrappedGraph)

getGenerationSettingsInterface

public JIPipeIterationStepGenerationSettings getGenerationSettingsInterface()

Description copied from interface: JIPipeIterationStepAlgorithm

Returns the batch generation settings as interface

Specified by:

getGenerationSettingsInterface in interface JIPipeIterationStepAlgorithm

Returns:

batch generation settings as interface

generateDataBatchesGenerationResult

public JIPipeDataBatchGenerationResult generateDataBatchesGenerationResult(List<JIPipeInputDataSlot> slots,
                                                                           JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeIterationStepAlgorithm

Generates iteration steps. This is a dry-run function that should never throw errors

Specified by:

generateDataBatchesGenerationResult in interface JIPipeIterationStepAlgorithm

Parameters:

slots - the data slots

progressInfo - the progress

Returns:

the batches

setScratchBaseDirectory

public void setScratchBaseDirectory(Path scratchBaseDirectory)

Description copied from class: JIPipeGraphNode

Sets the scratch base directory of the current run. Please note that this directory will be propagated to sub-graphs

Overrides:

setScratchBaseDirectory in class JIPipeGraphNode

Parameters:

scratchBaseDirectory - the scratch base directory

setBaseDirectory

public void setBaseDirectory(Path baseDirectory)

Description copied from class: JIPipeGraphNode

Sets the current work directory of this algorithm. This is used internally to allow loading data from relative paths. This triggers a JIPipeGraphNode.BaseDirectoryChangedEvent that can be received by JIPipeDataSlot instances to adapt to the work directory.

Overrides:

setBaseDirectory in class JIPipeGraphNode

Parameters:

baseDirectory - The work directory. Can be null

setProjectDirectory

public void setProjectDirectory(Path projectDirectory)

Description copied from class: JIPipeGraphNode

Sets the project directory. Can be null.

Overrides:

setProjectDirectory in class JIPipeGraphNode

Parameters:

projectDirectory - the project directory. can be null.

setRuntimeProject

public void setRuntimeProject(JIPipeProject runtimeProject)

Description copied from class: JIPipeGraphNode

Sets the current project associated with the current run

Overrides:

setRuntimeProject in class JIPipeGraphNode

Parameters:

runtimeProject - the project

setInternalStoragePath

public void setInternalStoragePath(Path internalStoragePath)

Description copied from class: JIPipeGraphNode

Sets the internal storage path relative to the output folder. Used internally by JIPipeGraphRun

Overrides:

setInternalStoragePath in class JIPipeGraphNode

Parameters:

internalStoragePath - Path relative to the output folder

getBatchGenerationSettings

public JIPipeMergingAlgorithmIterationStepGenerationSettings getBatchGenerationSettings()

setBatchGenerationSettings

public void setBatchGenerationSettings(JIPipeMergingAlgorithmIterationStepGenerationSettings batchGenerationSettings)

getIterationMode

public JIPipeGraphWrapperAlgorithm.IterationMode getIterationMode()

setIterationMode

public void setIterationMode(JIPipeGraphWrapperAlgorithm.IterationMode iterationMode)