org.hkijena.jipipe.extensions.python.algorithms

Class MergingJythonScriptAlgorithm

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.api.nodes.JIPipeMergingAlgorithm

org.hkijena.jipipe.extensions.python.algorithms.MergingJythonScriptAlgorithm

All Implemented Interfaces:

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

public class MergingJythonScriptAlgorithm
extends JIPipeMergingAlgorithm

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
MergingJythonScriptAlgorithm(JIPipeNodeInfo info) Creates a new instance
MergingJythonScriptAlgorithm(MergingJythonScriptAlgorithm other) Creates a copy

Method Summary

Modifier and Type	Method and Description
PythonScript	getCode()
JIPipeDynamicParameterCollection	getScriptParameters()
void	reportValidity(JIPipeValidationReportContext context, JIPipeValidationReport report) Generates a validity report
protected void	runIteration(JIPipeMergingDataBatch 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.JIPipeMergingAlgorithm

createUIInputSlotIconDescriptionMenuItems, generateDataBatchesDryRun, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getIgnoredAnnotationColumns, getParallelizationBatchSize, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, isParallelizationEnabled, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, setParallelizationEnabled, supportsParallelization

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

getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, onParameterChanged, 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, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDependencies, getDisplayName, getExternalEnvironments, 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, onDeserialized, 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.nodes.JIPipeAdaptiveParametersAlgorithm

installUIOverrideParameterEditor, installUIParameterOptions

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

emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, setParameter

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Constructor Detail

MergingJythonScriptAlgorithm

public MergingJythonScriptAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

MergingJythonScriptAlgorithm

public MergingJythonScriptAlgorithm(MergingJythonScriptAlgorithm other)

Creates a copy

Parameters:

other - the info

Method Detail

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

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(JIPipeMergingDataBatch dataBatch,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeMergingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeMergingAlgorithm

Parameters:

dataBatch - The data interface

progressInfo - the progress from the run

getCode

public PythonScript getCode()

setCode

public void setCode(PythonScript code)

getScriptParameters

public JIPipeDynamicParameterCollection getScriptParameters()