org.hkijena.jipipe.extensions.python.algorithms

Class SimpleIteratingJythonScriptAlgorithm

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeParameterSlotAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeSimpleIteratingAlgorithm

org.hkijena.jipipe.extensions.python.algorithms.SimpleIteratingJythonScriptAlgorithm

All Implemented Interfaces:

JIPipeFunctionallyComparable, JIPipeValidatable, JIPipeAdaptiveParametersAlgorithm, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection

public class SimpleIteratingJythonScriptAlgorithm
extends JIPipeSimpleIteratingAlgorithm

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

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Field Summary

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

SLOT_PARAMETERS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PythonScript	getCode()
JIPipeDynamicParameterCollection	getScriptParameters()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
protected void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setCode(PythonScript code)

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

generateDataBatchesDryRun, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getParallelizationBatchSize, isParallelizationEnabled, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, setParallelizationEnabled, supportsParallelization

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

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

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

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

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

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDependencies, getDisplayName, getEventBus, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getLocations, getLocationWithin, getName, getNewScratch, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProjectCompartment, getProjectDirectory, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isVisibleIn, onDeserialized, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, registerSubParameter, renderInputSlots, renderOutputSlots, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots

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

generateValidityReport

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

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

SimpleIteratingJythonScriptAlgorithm

public SimpleIteratingJythonScriptAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

SimpleIteratingJythonScriptAlgorithm

public SimpleIteratingJythonScriptAlgorithm(SimpleIteratingJythonScriptAlgorithm other)

Creates a copy

Parameters:

other - the info

Method Detail

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeSimpleIteratingAlgorithm

Parameters:

report - the report to be added to

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

runIteration

protected void runIteration(JIPipeDataBatch dataBatch,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeSimpleIteratingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeSimpleIteratingAlgorithm

Parameters:

dataBatch - The data interface

progressInfo - the progress info from the run

getCode

public PythonScript getCode()

setCode

public void setCode(PythonScript code)

getScriptParameters

public JIPipeDynamicParameterCollection getScriptParameters()