org.hkijena.jipipe.extensions.python.algorithms

Class PythonScriptAlgorithm

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

org.hkijena.jipipe.extensions.python.algorithms.PythonScriptAlgorithm

All Implemented Interfaces:

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

public class PythonScriptAlgorithm
extends JIPipeParameterSlotAlgorithm

An algorithm that allows to run Python code

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 inherited from class org.hkijena.jipipe.api.nodes.JIPipeParameterSlotAlgorithm

SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
PythonScriptAlgorithm(JIPipeNodeInfo info) Creates a new instance
PythonScriptAlgorithm(PythonScriptAlgorithm other) Creates a copy

Method Summary

Modifier and Type	Method and Description
JIPipeTextAnnotationMergeMode	getAnnotationMergeStrategy()
PythonScript	getCode()
void	getExternalEnvironments(List<JIPipeExternalEnvironment> target) Gathers all known external environments
OptionalPythonEnvironment	getOverrideEnvironment()
JIPipeDynamicParameterCollection	getScriptParameters()
boolean	isCleanUpAfterwards()
protected void	onDeserialized(com.fasterxml.jackson.databind.JsonNode node, JIPipeValidationReport issues, JIPipeNotificationInbox notifications) Override this method to add operations to be run after deserialization from JSON
void	reportValidity(JIPipeValidationReportContext context, JIPipeValidationReport report) Generates a validity report
void	runParameterSet(JIPipeProgressInfo progressInfo, List<JIPipeTextAnnotation> parameterAnnotations) Runs a parameter set iteration
void	setAnnotationMergeStrategy(JIPipeTextAnnotationMergeMode annotationMergeStrategy)
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setCleanUpAfterwards(boolean cleanUpAfterwards)
void	setCode(PythonScript code)
void	setOverrideEnvironment(OptionalPythonEnvironment overrideEnvironment)

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

createUIInputSlotIconDescriptionMenuItems, getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, isParameterUIVisible, onParameterChanged, run

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

canAutoPassThrough, canPassThrough, functionallyEquals, getThreadPool, isEnabled, isParameterUIVisible, isPassThrough, isPostprocessor, isPreprocessor, loadExample, runPassThrough, setEnabled, setPassThrough, setThreadPool

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, 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, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, registerSubParameter, renderInputSlots, renderOutputSlots, 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

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

emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, setParameter

Constructor Detail

PythonScriptAlgorithm

public PythonScriptAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

PythonScriptAlgorithm

public PythonScriptAlgorithm(PythonScriptAlgorithm other)

Creates a copy

Parameters:

other - the info

Method Detail

getOverrideEnvironment

public OptionalPythonEnvironment getOverrideEnvironment()

setOverrideEnvironment

public void setOverrideEnvironment(OptionalPythonEnvironment overrideEnvironment)

isCleanUpAfterwards

public boolean isCleanUpAfterwards()

setCleanUpAfterwards

public void setCleanUpAfterwards(boolean cleanUpAfterwards)

getExternalEnvironments

public void getExternalEnvironments(List<JIPipeExternalEnvironment> target)

Description copied from class: JIPipeGraphNode

Gathers all known external environments

Overrides:

getExternalEnvironments in class JIPipeGraphNode

Parameters:

target - the list where the external environments will be gathered

reportValidity

public void reportValidity(JIPipeValidationReportContext context,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeAlgorithm

report - the report to be added to

runParameterSet

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

Description copied from class: JIPipeParameterSlotAlgorithm

Runs a parameter set iteration

Specified by:

runParameterSet in class JIPipeParameterSlotAlgorithm

Parameters:

progressInfo - progress info from the run

parameterAnnotations - parameter annotations

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

getCode

public PythonScript getCode()

setCode

public void setCode(PythonScript code)

getScriptParameters

public JIPipeDynamicParameterCollection getScriptParameters()

getAnnotationMergeStrategy

public JIPipeTextAnnotationMergeMode getAnnotationMergeStrategy()

setAnnotationMergeStrategy

public void setAnnotationMergeStrategy(JIPipeTextAnnotationMergeMode annotationMergeStrategy)

onDeserialized

protected void onDeserialized(com.fasterxml.jackson.databind.JsonNode node,
                              JIPipeValidationReport issues,
                              JIPipeNotificationInbox notifications)

Description copied from class: JIPipeGraphNode

Override this method to add operations to be run after deserialization from JSON

Overrides:

onDeserialized in class JIPipeGraphNode

Parameters:

node - the JSON node where the data was loaded

issues - issues during deserialization. if you want to notify the user about potential issues that can be acted upon, use the notification inbox

notifications - additional notifications for the user. these can be acted upon