org.hkijena.jipipe.api.grouping

Class GraphWrapperAlgorithm

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.grouping.GraphWrapperAlgorithm

All Implemented Interfaces:

JIPipeValidatable, JIPipeDataBatchAlgorithm, JIPipeParameterCollection

Direct Known Subclasses:

JsonAlgorithm, NodeGroup

public class GraphWrapperAlgorithm
extends JIPipeAlgorithm
implements JIPipeDataBatchAlgorithm

An algorithm that wraps another algorithm graph

Nested Class Summary

Nested Classes

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

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

JIPipeAlgorithm.StateSerializer

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

JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.Serializer

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<JIPipeMergingDataBatch>	generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots, JIPipeProgressInfo progressInfo) Generates data batches.
JIPipeMergingAlgorithmDataBatchGenerationSettings	getBatchGenerationSettings()
Set<JIPipeDependency>	getDependencies() Returns a list of all dependencies this algorithm currently has.
JIPipeDataBatchGenerationSettings	getGenerationSettingsInterface() Returns the batch generation settings as interface
GraphWrapperAlgorithmInput	getGroupInput() Gets the graphs's input node
GraphWrapperAlgorithmOutput	getGroupOutput() Gets the graphs's output node
GraphWrapperAlgorithm.IterationMode	getIterationMode()
JIPipeGraph	getWrappedGraph()
boolean	isPreventUpdateSlots()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	run(JIPipeProgressInfo progressInfo) Runs the workload
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setInternalStoragePath(Path internalStoragePath) Sets the internal storage path relative to the output folder.
void	setIterationMode(GraphWrapperAlgorithm.IterationMode iterationMode)
void	setPreventUpdateSlots(boolean preventUpdateSlots)
void	setProjectDirectory(Path projectDirectory) Sets the project directory.
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, getStateId, getThreadPool, isEnabled, isParameterUIVisible, isPassThrough, isPostprocessor, isPreprocessor, loadExample, runPassThrough, setEnabled, setPassThrough, setThreadPool

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

canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDataInputSlots, getDisplayName, getEventBus, getFirstInputSlot, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getLocations, getLocationWithin, getName, getNewScratch, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProjectCompartment, getProjectDirectory, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isVisibleIn, onDeserialized, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, onSlotConnected, onSlotDisconnected, registerSubParameter, renderInputSlots, renderOutputSlots, setAllSlotsVirtual, setBookmarked, setCustomDescription, setCustomName, setInfo, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots, updateSlotInheritance

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.JIPipeValidatable

generateValidityReport

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

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

GraphWrapperAlgorithm

public GraphWrapperAlgorithm(JIPipeNodeInfo info,
                             JIPipeGraph wrappedGraph)

Parameters:

info - the info

wrappedGraph - the graph wrapper

GraphWrapperAlgorithm

public GraphWrapperAlgorithm(GraphWrapperAlgorithm other)

Copies the algorithm

Parameters:

other - the original

Method Detail

updateGroupSlots

public void updateGroupSlots()

Updates the slots from the wrapped graph

isPreventUpdateSlots

public boolean isPreventUpdateSlots()

setPreventUpdateSlots

public void setPreventUpdateSlots(boolean preventUpdateSlots)

getGroupInput

public GraphWrapperAlgorithmInput getGroupInput()

Gets the graphs's input node

Returns:

the graph's input node

getGroupOutput

public GraphWrapperAlgorithmOutput getGroupOutput()

Gets the graphs's output node

Returns:

the graph's output node

run

public void run(JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Overrides:

run in class JIPipeAlgorithm

Parameters:

progressInfo - progress passed from the runner

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeAlgorithm

Parameters:

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:

List of dependencies

getWrappedGraph

public JIPipeGraph getWrappedGraph()

setWrappedGraph

public void setWrappedGraph(JIPipeGraph wrappedGraph)

getGenerationSettingsInterface

public JIPipeDataBatchGenerationSettings getGenerationSettingsInterface()

Description copied from interface: JIPipeDataBatchAlgorithm

Returns the batch generation settings as interface

Specified by:

getGenerationSettingsInterface in interface JIPipeDataBatchAlgorithm

Returns:

batch generation settings as interface

generateDataBatchesDryRun

public List<JIPipeMergingDataBatch> generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots,
                                                              JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeDataBatchAlgorithm

Generates data batches. This is a dry-run function that should never throw errors

Specified by:

generateDataBatchesDryRun in interface JIPipeDataBatchAlgorithm

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.

setInternalStoragePath

public void setInternalStoragePath(Path internalStoragePath)

Description copied from class: JIPipeGraphNode

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

Overrides:

setInternalStoragePath in class JIPipeGraphNode

Parameters:

internalStoragePath - Path relative to the output folder

getBatchGenerationSettings

public JIPipeMergingAlgorithmDataBatchGenerationSettings getBatchGenerationSettings()

getIterationMode

public GraphWrapperAlgorithm.IterationMode getIterationMode()

setIterationMode

public void setIterationMode(GraphWrapperAlgorithm.IterationMode iterationMode)