org.hkijena.jipipe.api.nodes.algorithm

Class JIPipeParameterlessSimpleIteratingAlgorithm

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AnnotationsToParametersAlgorithm, ParametersToAnnotationsAlgorithm

public abstract class JIPipeParameterlessSimpleIteratingAlgorithm
extends JIPipeAlgorithm
implements JIPipeParallelizedAlgorithm, JIPipeIterationStepAlgorithm

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

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

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
JIPipeDataBatchGenerationResult	generateDataBatchesGenerationResult(List<JIPipeInputDataSlot> slots, JIPipeProgressInfo progressInfo) Generates iteration steps.
JIPipeParameterlessSimpleIteratingAlgorithm.IterationStepGenerationSettings	getDataBatchGenerationSettings()
JIPipeIterationStepGenerationSettings	getGenerationSettingsInterface() Returns the batch generation settings as interface
int	getParallelizationBatchSize() Returns how many threads the actual algorithm requires.
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(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
protected abstract void	runIteration(JIPipeSingleIterationStep iterationStep, JIPipeIterationContext iterationContext, JIPipeProgressInfo progressInfo) Runs code on one data row
boolean	supportsParallelization() Indicates to the algorithm base implementation if parallelization is supported.

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, createUIInputSlotIconDescriptionMenuItems, duplicate, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDataInputSlots, getDependencies, getDisplayName, getEnvironmentDependencies, getFirstInputSlot, 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, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onParameterChanged, onSlotConfigurationChanged, renderInputSlots, renderOutputSlots, setBaseDirectory, 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.api.nodes.iterationstep.JIPipeIterationStepAlgorithm

generateDataBatchesDryRun

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

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

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(JIPipeGraphNodeRunContext runContext,
                JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Overrides:

run in class JIPipeAlgorithm

Parameters:

runContext - the context of the run process

progressInfo - progress passed from the runner

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 abstract void runIteration(JIPipeSingleIterationStep iterationStep,
                                     JIPipeIterationContext iterationContext,
                                     JIPipeProgressInfo progressInfo)

Runs code on one data row

Parameters:

iterationStep - The data interface

iterationContext - The iteration context

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

getDataBatchGenerationSettings

public JIPipeParameterlessSimpleIteratingAlgorithm.IterationStepGenerationSettings getDataBatchGenerationSettings()

getGenerationSettingsInterface

public JIPipeIterationStepGenerationSettings getGenerationSettingsInterface()

Description copied from interface: JIPipeIterationStepAlgorithm

Returns the batch generation settings as interface

Specified by:

getGenerationSettingsInterface in interface JIPipeIterationStepAlgorithm

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

Overrides:

isParameterUIVisible in class JIPipeAlgorithm

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

generateDataBatchesGenerationResult

public JIPipeDataBatchGenerationResult generateDataBatchesGenerationResult(List<JIPipeInputDataSlot> slots,
                                                                           JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeIterationStepAlgorithm

Generates iteration steps. This is a dry-run function that should never throw errors

Specified by:

generateDataBatchesGenerationResult in interface JIPipeIterationStepAlgorithm

Parameters:

slots - the data slots

progressInfo - the progress

Returns:

the batches