org.hkijena.jipipe.plugins.python.algorithms.python

Class MergingPythonScriptAlgorithm

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

org.hkijena.jipipe.api.nodes.algorithm.JIPipeMergingAlgorithm

org.hkijena.jipipe.plugins.python.algorithms.python.MergingPythonScriptAlgorithm

All Implemented Interfaces:

JIPipeSlotConfiguration.SlotConfigurationChangedEventListener, JIPipeFunctionallyComparable, JIPipeIterationStepAlgorithm, JIPipeAdaptiveParametersAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable, PythonEnvironmentAccessNode

public class MergingPythonScriptAlgorithm
extends JIPipeMergingAlgorithm
implements PythonEnvironmentAccessNode

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

SLOT_PARAMETERS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
JIPipeTextAnnotationMergeMode	getAnnotationMergeStrategy()
PythonScript	getCode()
void	getEnvironmentDependencies(List<JIPipeEnvironment> target) Gathers all known external environments
OptionalPythonEnvironment	getOverrideEnvironment()
JIPipeDynamicParameterCollection	getScriptParameters()
boolean	isCleanUpAfterwards()
boolean	isSuppressLogs()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
protected void	runIteration(JIPipeMultiIterationStep iterationStep, JIPipeIterationContext iterationContext, JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs code on one data row
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)
void	setSuppressLogs(boolean suppressLogs)

Methods inherited from class org.hkijena.jipipe.api.nodes.algorithm.JIPipeMergingAlgorithm

createUIInputSlotIconDescriptionMenuItems, generateDataBatchesGenerationResult, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getIgnoredAnnotationColumns, getParallelizationBatchSize, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, supportsParallelization

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

getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, onParameterChanged, run

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

canAutoPassThrough, canPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isPassThrough, isPostprocessor, isPreprocessor, isSkipped, loadExample, onDeserialized, 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, 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, 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.plugins.python.algorithms.python.PythonEnvironmentAccessNode

getConfiguredPythonAdapterEnvironment, getConfiguredPythonEnvironment, reportConfiguredPythonEnvironmentValidity

Methods inherited from interface org.hkijena.jipipe.api.nodes.iterationstep.JIPipeIterationStepAlgorithm

generateDataBatchesDryRun

Methods inherited from interface org.hkijena.jipipe.api.nodes.JIPipeAdaptiveParametersAlgorithm

installUIOverrideParameterEditor, installUIParameterOptions

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

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

Constructor Detail

MergingPythonScriptAlgorithm

public MergingPythonScriptAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

MergingPythonScriptAlgorithm

public MergingPythonScriptAlgorithm(MergingPythonScriptAlgorithm other)

Creates a copy

Parameters:

other - the info

Method Detail

isCleanUpAfterwards

public boolean isCleanUpAfterwards()

setCleanUpAfterwards

public void setCleanUpAfterwards(boolean cleanUpAfterwards)

getOverrideEnvironment

public OptionalPythonEnvironment getOverrideEnvironment()

Specified by:

getOverrideEnvironment in interface PythonEnvironmentAccessNode

setOverrideEnvironment

public void setOverrideEnvironment(OptionalPythonEnvironment overrideEnvironment)

isSuppressLogs

public boolean isSuppressLogs()

setSuppressLogs

public void setSuppressLogs(boolean suppressLogs)

getEnvironmentDependencies

public void getEnvironmentDependencies(List<JIPipeEnvironment> target)

Description copied from class: JIPipeGraphNode

Gathers all known external environments

Overrides:

getEnvironmentDependencies in class JIPipeGraphNode

Parameters:

target - the list where the external environments will be gathered

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeAlgorithm

Parameters:

reportContext - the report context

report - the report to be added to

runIteration

protected void runIteration(JIPipeMultiIterationStep iterationStep,
                            JIPipeIterationContext iterationContext,
                            JIPipeGraphNodeRunContext runContext,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeMergingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeMergingAlgorithm

Parameters:

iterationStep - The data interface

iterationContext - The iteration context

runContext - the run context

progressInfo - the progress from the run

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)