org.hkijena.jipipe.api.nodes.algorithm

Class JIPipeParameterSlotAlgorithm

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnotateWithAnnotationTable, DataSlicer, ExtractTableAlgorithm, GenerateRandomUniqueAnnotation, JIPipeIteratingAlgorithm, JIPipeIteratingMissingDataGeneratorAlgorithm, JIPipeMergingAlgorithm, JIPipeMissingDataGeneratorAlgorithm, JIPipeSimpleIteratingAlgorithm, JIPipeSingleIterationAlgorithm, JythonScriptAlgorithm, PythonScriptAlgorithm, RemoveArrayAnnotationsAlgorithm, RemoveNAAnnotationColumnsAlgorithm, SelectDataTableRowsAlgorithm, SleepAlgorithm, SortRowsByAnnotationsAlgorithm, SortRowsByExpressionAlgorithm, TemporaryFileDataSource, TemporaryFolderDataSource

public abstract class JIPipeParameterSlotAlgorithm
extends JIPipeAlgorithm

An JIPipeAlgorithm that has an optional slot that allows to supply parameter data sets.

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

Modifier and Type	Field and Description
static String	SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
JIPipeParameterSlotAlgorithm(JIPipeNodeInfo info)
JIPipeParameterSlotAlgorithm(JIPipeNodeInfo info, JIPipeSlotConfiguration slotConfiguration)
JIPipeParameterSlotAlgorithm(JIPipeParameterSlotAlgorithm other)

Method Summary

Modifier and Type	Method and Description
void	createUIInputSlotIconDescriptionMenuItems(String slotName, List<ViewOnlyMenuItem> target) Explanations added to the slot menu Can be null
int	getDataInputSlotCount() Returns the number of input slots that are not parameter slots.
List<JIPipeInputDataSlot>	getDataInputSlots() Method that can be overwritten by child classes.
JIPipeInputDataSlot	getFirstInputSlot() Returns the first input slot according to the slot order.
List<JIPipeInputDataSlot>	getNonParameterInputSlots()
JIPipeDataSlot	getParameterSlot() Returns the parameter slot if enabled
JIPipeParameterSlotAlgorithmSettings	getParameterSlotAlgorithmSettings()
ImageIcon	getUIInputSlotIcon(String slotName) An icon that is displayed on the right-hand side of the input slot Can be null
Dimension	getUIInputSlotIconBaseDimensions(String slotName) Size of the icon returned by getUIInputSlotIcon Should be at most 16x16 Defaults to 12x12
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter) Allows to override the visibility of sub-parameters inside the UI
void	onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event) Triggered when a parameter is changed within the slot configuration.
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
abstract void	runParameterSet(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo, List<JIPipeTextAnnotation> parameterAnnotations) Runs a parameter set iteration

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

canAutoPassThrough, canPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isParameterUIVisible, 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.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

Field Detail

SLOT_PARAMETERS

public static final String SLOT_PARAMETERS

See Also:

Constant Field Values

Constructor Detail

JIPipeParameterSlotAlgorithm

public JIPipeParameterSlotAlgorithm(JIPipeNodeInfo info,
                                    JIPipeSlotConfiguration slotConfiguration)

JIPipeParameterSlotAlgorithm

public JIPipeParameterSlotAlgorithm(JIPipeNodeInfo info)

JIPipeParameterSlotAlgorithm

public JIPipeParameterSlotAlgorithm(JIPipeParameterSlotAlgorithm other)

Method Detail

onParameterChanged

public void onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event)

Description copied from class: JIPipeGraphNode

Triggered when a parameter is changed within the slot configuration. Triggers a JIPipeGraphNode.NodeSlotsChangedEvent

Specified by:

onParameterChanged in interface JIPipeParameterCollection.ParameterChangedEventListener

Overrides:

onParameterChanged in class JIPipeGraphNode

Parameters:

event - generated event

getDataInputSlotCount

public int getDataInputSlotCount()

Returns the number of input slots that are not parameter slots.

Returns:

the number of input slots that are not parameter slots.

getNonParameterInputSlots

public List<JIPipeInputDataSlot> getNonParameterInputSlots()

getDataInputSlots

public List<JIPipeInputDataSlot> getDataInputSlots()

Description copied from class: JIPipeGraphNode

Method that can be overwritten by child classes. Should return slots that are actually used as data input.

Overrides:

getDataInputSlots in class JIPipeGraphNode

Returns:

Input slots

getFirstInputSlot

public JIPipeInputDataSlot getFirstInputSlot()

Description copied from class: JIPipeGraphNode

Returns the first input slot according to the slot order. Throws IndexOutOfBoundsException if there is no input slot.

Overrides:

getFirstInputSlot in class JIPipeGraphNode

Returns:

Slot instance

getParameterSlotAlgorithmSettings

public JIPipeParameterSlotAlgorithmSettings getParameterSlotAlgorithmSettings()

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterCollection subParameter)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of sub-parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Overrides:

isParameterUIVisible in class JIPipeAlgorithm

Parameters:

tree - the parameter tree that is used to access this parameter

subParameter - a sub parameter

Returns:

if the parameter is visible inside the UI

getParameterSlot

public JIPipeDataSlot getParameterSlot()

Returns the parameter slot if enabled

Returns:

the parameter slot

getUIInputSlotIconBaseDimensions

public Dimension getUIInputSlotIconBaseDimensions(String slotName)

Description copied from class: JIPipeGraphNode

Size of the icon returned by getUIInputSlotIcon Should be at most 16x16 Defaults to 12x12

Overrides:

getUIInputSlotIconBaseDimensions in class JIPipeGraphNode

Parameters:

slotName - the slot name

Returns:

the icon size

getUIInputSlotIcon

public ImageIcon getUIInputSlotIcon(String slotName)

Description copied from class: JIPipeGraphNode

An icon that is displayed on the right-hand side of the input slot Can be null

Overrides:

getUIInputSlotIcon in class JIPipeGraphNode

Parameters:

slotName - the slot name

Returns:

the icon or null

createUIInputSlotIconDescriptionMenuItems

public void createUIInputSlotIconDescriptionMenuItems(String slotName,
                                                      List<ViewOnlyMenuItem> target)

Description copied from class: JIPipeGraphNode

Explanations added to the slot menu Can be null

Overrides:

createUIInputSlotIconDescriptionMenuItems in class JIPipeGraphNode

Parameters:

slotName - the slot name

target - the list of menu items

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

runParameterSet

public abstract void runParameterSet(JIPipeGraphNodeRunContext runContext,
                                     JIPipeProgressInfo progressInfo,
                                     List<JIPipeTextAnnotation> parameterAnnotations)

Runs a parameter set iteration

Parameters:

runContext - the run context

progressInfo - progress info from the run

parameterAnnotations - parameter annotations