org.hkijena.jipipe.api.compartments.algorithms

Class IOInterfaceAlgorithm

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.compartments.algorithms.IOInterfaceAlgorithm

All Implemented Interfaces:

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

Direct Known Subclasses:

GraphWrapperAlgorithmInput, GraphWrapperAlgorithmOutput, JIPipeProjectCompartmentOutput, LoopEndNode, LoopStartNode

public class IOInterfaceAlgorithm
extends JIPipeAlgorithm

Algorithm that passes the input to the output

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

Constructor Summary

Constructors

Constructor and Description
IOInterfaceAlgorithm(IOInterfaceAlgorithm other) Creates a copy of the other algorithm
IOInterfaceAlgorithm(JIPipeNodeInfo info) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	canAutoPassThrough() Returns true if the algorithm can automatically apply pass-through This is only possible if there is at most one input and at most one output.
static void	collapse(IOInterfaceAlgorithm algorithm) Removes the interface and directly connects the inputs and outputs
static void	replaceCompartmentOutput(JIPipeProjectCompartmentOutput compartmentOutput) Replaces a JIPipeProjectCompartmentOutput by an equivalent interface
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
protected void	runPassThrough(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the pass through.

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

canPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isParameterUIVisible, isParameterUIVisible, isPassThrough, isPostprocessor, isPreprocessor, isSkipped, loadExample, onDeserialized, reportValidity, 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, getDependencies, getDisplayName, getEnvironmentDependencies, getFirstInputSlot, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getLocations, getLocationWithin, getName, getNewScratch, getNodeSlotsChangedEventEmitter, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProjectCompartment, getProjectDataDirs, getProjectDirectory, getRuntimeProject, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getTextDescription, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onParameterChanged, onSlotConfigurationChanged, renderInputSlots, renderOutputSlots, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, 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.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

IOInterfaceAlgorithm

public IOInterfaceAlgorithm(JIPipeNodeInfo info)

Creates a new instance. Please do not use this constructor manually, but instead use JIPipeGraphNode's newInstance() method

Parameters:

info - The algorithm info

IOInterfaceAlgorithm

public IOInterfaceAlgorithm(IOInterfaceAlgorithm other)

Creates a copy of the other algorithm

Parameters:

other - The original

Method Detail

collapse

public static void collapse(IOInterfaceAlgorithm algorithm)

Removes the interface and directly connects the inputs and outputs

Parameters:

algorithm - the algorithm

replaceCompartmentOutput

public static void replaceCompartmentOutput(JIPipeProjectCompartmentOutput compartmentOutput)

Replaces a JIPipeProjectCompartmentOutput by an equivalent interface

Parameters:

compartmentOutput - the output to be replaced

canAutoPassThrough

protected boolean canAutoPassThrough()

Description copied from class: JIPipeAlgorithm

Returns true if the algorithm can automatically apply pass-through This is only possible if there is at most one input and at most one output. Input must be compatible to the output.

Overrides:

canAutoPassThrough in class JIPipeAlgorithm

Returns:

if the algorithm can automatically apply pass-through

runPassThrough

protected void runPassThrough(JIPipeGraphNodeRunContext runContext,
                              JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeAlgorithm

Runs the pass through. Override this for custom implementations if you want

Overrides:

runPassThrough in class JIPipeAlgorithm

Parameters:

runContext - the context of the running operation

progressInfo - the progress

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