org.hkijena.jipipe.extensions.utils.algorithms.meta

Class RunJIPipeProjectAlgorithm

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.utils.algorithms.meta.RunJIPipeProjectAlgorithm

All Implemented Interfaces:

JIPipeValidatable, JIPipeAdaptiveParametersAlgorithm, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection

public class RunJIPipeProjectAlgorithm
extends JIPipeSimpleIteratingAlgorithm

Runs a JIPipe project

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

JIPipeAlgorithm.StateSerializer

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

Method Summary

Modifier and Type	Method and Description
Path	getProjectFile()
OptionalIntegerParameter	getThreads()
boolean	isIgnoreValidation()
protected void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setIgnoreValidation(boolean ignoreValidation)
void	setProjectFile(Path projectFile)
void	setThreads(OptionalIntegerParameter threads)
boolean	supportsParallelization() Indicates to the algorithm base implementation if parallelization is supported.

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

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

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, getStateId, getThreadPool, isEnabled, isPassThrough, isPostprocessor, isPreprocessor, loadExample, runPassThrough, setEnabled, setPassThrough, setThreadPool

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

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, onSlotConnected, onSlotDisconnected, registerSubParameter, renderInputSlots, renderOutputSlots, setAllSlotsVirtual, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots, updateSlotInheritance

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, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

RunJIPipeProjectAlgorithm

public RunJIPipeProjectAlgorithm(JIPipeNodeInfo info)

RunJIPipeProjectAlgorithm

public RunJIPipeProjectAlgorithm(RunJIPipeProjectAlgorithm other)

Method Detail

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

supportsParallelization

public boolean supportsParallelization()

Description copied from interface: JIPipeParallelizedAlgorithm

Indicates to the algorithm base implementation if parallelization is supported. Use this function to indicate to the algorithm to conditionally enable/disable parallelization.

Specified by:

supportsParallelization in interface JIPipeParallelizedAlgorithm

Overrides:

supportsParallelization in class JIPipeSimpleIteratingAlgorithm

Returns:

If the algorithm supports automated parallelization.

getProjectFile

public Path getProjectFile()

setProjectFile

public void setProjectFile(Path projectFile)

getThreads

public OptionalIntegerParameter getThreads()

setThreads

public void setThreads(OptionalIntegerParameter threads)

isIgnoreValidation

public boolean isIgnoreValidation()

setIgnoreValidation

public void setIgnoreValidation(boolean ignoreValidation)