org.hkijena.jipipe.api.nodes

Class JIPipeParameterlessSimpleIteratingAlgorithm

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeParameterlessSimpleIteratingAlgorithm

All Implemented Interfaces:

JIPipeValidatable, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection

Direct Known Subclasses:

AnnotationsToParametersAlgorithm, ParametersToAnnotationsAlgorithm

public abstract class JIPipeParameterlessSimpleIteratingAlgorithm
extends JIPipeAlgorithm
implements JIPipeParallelizedAlgorithm, JIPipeDataBatchAlgorithm

An JIPipeAlgorithm that iterates through each data row. This is a simplified version of JIPipeIteratingAlgorithm that assumes that there is only one or zero input slots. An error is thrown if there are more than one input slots.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeParameterlessSimpleIteratingAlgorithm.DataBatchGenerationSettings

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

Constructor Summary

Constructors

Constructor and Description
JIPipeParameterlessSimpleIteratingAlgorithm(JIPipeNodeInfo info) Creates a new instance
JIPipeParameterlessSimpleIteratingAlgorithm(JIPipeNodeInfo info, JIPipeSlotConfiguration slotConfiguration) Creates a new instance
JIPipeParameterlessSimpleIteratingAlgorithm(JIPipeParameterlessSimpleIteratingAlgorithm other) Copies the algorithm

Method Summary

Modifier and Type	Method and Description
List<JIPipeMergingDataBatch>	generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots, JIPipeProgressInfo progressInfo) Generates data batches.
JIPipeParameterlessSimpleIteratingAlgorithm.DataBatchGenerationSettings	getDataBatchGenerationSettings()
JIPipeDataBatchGenerationSettings	getGenerationSettingsInterface() Returns the batch generation settings as interface
int	getParallelizationBatchSize() Returns how many threads the actual algorithm requires.
boolean	isParallelizationEnabled()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter) Allows to override the visibility of sub-parameters inside the UI
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	run(JIPipeProgressInfo progressInfo) Runs the workload
protected abstract void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setParallelizationEnabled(boolean parallelizationEnabled) User-defined parameter to control if parallelization is enabled
boolean	supportsParallelization() Indicates to the algorithm base implementation if parallelization is supported.

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, getDataInputSlots, getDependencies, getDisplayName, getEventBus, getFirstInputSlot, 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

JIPipeParameterlessSimpleIteratingAlgorithm

public JIPipeParameterlessSimpleIteratingAlgorithm(JIPipeNodeInfo info,
                                                   JIPipeSlotConfiguration slotConfiguration)

Creates a new instance

Parameters:

info - Algorithm info

slotConfiguration - Slot configuration override

JIPipeParameterlessSimpleIteratingAlgorithm

public JIPipeParameterlessSimpleIteratingAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - Algorithm info

JIPipeParameterlessSimpleIteratingAlgorithm

public JIPipeParameterlessSimpleIteratingAlgorithm(JIPipeParameterlessSimpleIteratingAlgorithm other)

Copies the algorithm

Parameters:

other - The original

Method Detail

run

public void run(JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Overrides:

run in class JIPipeAlgorithm

Parameters:

progressInfo - progress passed from the runner

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 JIPipeAlgorithm

Parameters:

report - the report to be added to

runIteration

protected abstract void runIteration(JIPipeDataBatch dataBatch,
                                     JIPipeProgressInfo progressInfo)

Runs code on one data row

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

Returns:

If the algorithm supports automated parallelization.

getParallelizationBatchSize

public int getParallelizationBatchSize()

Description copied from interface: JIPipeParallelizedAlgorithm

Returns how many threads the actual algorithm requires. Based on this value, the base algorithm creates batches.

Specified by:

getParallelizationBatchSize in interface JIPipeParallelizedAlgorithm

Returns:

number of threads used by the workload

isParallelizationEnabled

public boolean isParallelizationEnabled()

Specified by:

isParallelizationEnabled in interface JIPipeParallelizedAlgorithm

Returns:

if parallelization is enabled by user

setParallelizationEnabled

public void setParallelizationEnabled(boolean parallelizationEnabled)

Description copied from interface: JIPipeParallelizedAlgorithm

User-defined parameter to control if parallelization is enabled

Specified by:

setParallelizationEnabled in interface JIPipeParallelizedAlgorithm

Parameters:

parallelizationEnabled - if parallelization is enabled

getDataBatchGenerationSettings

public JIPipeParameterlessSimpleIteratingAlgorithm.DataBatchGenerationSettings getDataBatchGenerationSettings()

getGenerationSettingsInterface

public JIPipeDataBatchGenerationSettings getGenerationSettingsInterface()

Description copied from interface: JIPipeDataBatchAlgorithm

Returns the batch generation settings as interface

Specified by:

getGenerationSettingsInterface in interface JIPipeDataBatchAlgorithm

Returns:

batch generation settings as interface

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterCollection subParameter)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of sub-parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Parameters:

tree - the parameter tree that is used to access this parameter

subParameter - a sub parameter

Returns:

if the parameter is visible inside the UI

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Overrides:

isParameterUIVisible in class JIPipeAlgorithm

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

generateDataBatchesDryRun

public List<JIPipeMergingDataBatch> generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots,
                                                              JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeDataBatchAlgorithm

Generates data batches. This is a dry-run function that should never throw errors

Specified by:

generateDataBatchesDryRun in interface JIPipeDataBatchAlgorithm

Parameters:

slots - the data slots

progressInfo - the progress

Returns:

the batches