org.hkijena.jipipe.plugins.multiparameters.nodes

Class ExtractParametersAlgorithm

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.plugins.multiparameters.nodes.ExtractParametersAlgorithm

All Implemented Interfaces:

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

public class ExtractParametersAlgorithm
extends JIPipeAlgorithm

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
ExtractParametersAlgorithm(ExtractParametersAlgorithm other)
ExtractParametersAlgorithm(JIPipeNodeInfo info)

Method Summary

Modifier and Type	Method and Description
boolean	canPassThrough() Returns true if the algorithm can apply pass-through.
OptionalTextAnnotationNameParameter	getNodeAliasIDAnnotation()
OptionalTextAnnotationNameParameter	getNodeNameAnnotation()
OptionalTextAnnotationNameParameter	getNodeUUIDAnnotation()
StringQueryExpression	getParameterKeyFilter()
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
void	setNodeAliasIDAnnotation(OptionalTextAnnotationNameParameter nodeAliasIDAnnotation)
void	setNodeNameAnnotation(OptionalTextAnnotationNameParameter nodeNameAnnotation)
void	setNodeUUIDAnnotation(OptionalTextAnnotationNameParameter nodeUUIDAnnotation)
void	setParameterKeyFilter(StringQueryExpression parameterKeyFilter)

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

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

Constructor Detail

ExtractParametersAlgorithm

public ExtractParametersAlgorithm(JIPipeNodeInfo info)

ExtractParametersAlgorithm

public ExtractParametersAlgorithm(ExtractParametersAlgorithm other)

Method Detail

canPassThrough

public boolean canPassThrough()

Description copied from class: JIPipeAlgorithm

Returns true if the algorithm can apply pass-through. Override this method to implement your own checks

Overrides:

canPassThrough in class JIPipeAlgorithm

Returns:

true if the algorithm can apply pass-through

getNodeUUIDAnnotation

public OptionalTextAnnotationNameParameter getNodeUUIDAnnotation()

setNodeUUIDAnnotation

public void setNodeUUIDAnnotation(OptionalTextAnnotationNameParameter nodeUUIDAnnotation)

getNodeAliasIDAnnotation

public OptionalTextAnnotationNameParameter getNodeAliasIDAnnotation()

setNodeAliasIDAnnotation

public void setNodeAliasIDAnnotation(OptionalTextAnnotationNameParameter nodeAliasIDAnnotation)

getNodeNameAnnotation

public OptionalTextAnnotationNameParameter getNodeNameAnnotation()

setNodeNameAnnotation

public void setNodeNameAnnotation(OptionalTextAnnotationNameParameter nodeNameAnnotation)

getParameterKeyFilter

public StringQueryExpression getParameterKeyFilter()

setParameterKeyFilter

public void setParameterKeyFilter(StringQueryExpression parameterKeyFilter)

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