org.hkijena.jipipe.api.grouping

Class JsonAlgorithm

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.grouping.JIPipeGraphWrapperAlgorithm

org.hkijena.jipipe.api.grouping.JsonAlgorithm

All Implemented Interfaces:

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

public class JsonAlgorithm
extends JIPipeGraphWrapperAlgorithm
implements JIPipeCustomParameterCollection

An algorithm that was imported from a Json extension.

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.grouping.JIPipeGraphWrapperAlgorithm

JIPipeGraphWrapperAlgorithm.IterationMode, JIPipeGraphWrapperAlgorithm.IterationModeEnumInfo

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
JsonAlgorithm(JIPipeGraphWrapperAlgorithm other) Makes a copy
JsonAlgorithm(JsonNodeInfo info) Creates a new instance

Method Summary

Modifier and Type	Method and Description
JIPipeMergingAlgorithmIterationStepGenerationSettings	getBatchGenerationSettings()
Map<String,JIPipeParameterCollection>	getChildParameterCollections() Returns all sub-parameter collections
GraphNodeParameterReferenceGroupCollection	getExportedParameters()
boolean	getIncludeReflectionParameters() If true, also include parameters discovered via reflection.
JIPipeGraphWrapperAlgorithm.IterationMode	getIterationMode()
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter) Allows to override the visibility of sub-parameters inside the UI
void	setIterationMode(JIPipeGraphWrapperAlgorithm.IterationMode iterationMode)
static void	unpackToNodeGroup(JsonAlgorithm algorithm) Replaces the targeted algorithm by a JIPipeNodeGroup

Methods inherited from class org.hkijena.jipipe.api.grouping.JIPipeGraphWrapperAlgorithm

generateDataBatchesGenerationResult, getContinueOnFailure, getContinueOnFailureExportFailedInputs, getDependencies, getGenerationSettingsInterface, getGroupInput, getGroupOutput, getWrappedGraph, isContinueOnFailure, isPreventUpdateSlots, reportValidity, run, setBaseDirectory, setBatchGenerationSettings, setContinueOnFailure, setContinueOnFailureExportFailedInputs, setInternalStoragePath, setPreventUpdateSlots, setProjectDirectory, setRuntimeProject, setScratchBaseDirectory, setWrappedGraph, updateGroupSlots

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

canAutoPassThrough, canPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isParameterUIVisible, 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, 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, setBookmarked, setCustomDescription, setCustomName, setInfo, setNodeUILocationPerViewModePerCompartment, setNodeUILocationWithin, setNodeUILocationWithin, setParentGraph, 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.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

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

Constructor Detail

JsonAlgorithm

public JsonAlgorithm(JsonNodeInfo info)

Creates a new instance

Parameters:

info - the info

JsonAlgorithm

public JsonAlgorithm(JIPipeGraphWrapperAlgorithm other)

Makes a copy

Parameters:

other - the original

Method Detail

unpackToNodeGroup

public static void unpackToNodeGroup(JsonAlgorithm algorithm)

Replaces the targeted algorithm by a JIPipeNodeGroup

Parameters:

algorithm - the algorithm

getExportedParameters

public GraphNodeParameterReferenceGroupCollection getExportedParameters()

getParameters

public Map<String,JIPipeParameterAccess> getParameters()

Description copied from interface: JIPipeCustomParameterCollection

Returns all parameters Please note that those parameters must be sourced in this collection. Use getChildParameterCollections() to add those

Specified by:

getParameters in interface JIPipeCustomParameterCollection

Returns:

Map from parameter ID to its access. The ID is not necessarily equal to JIPipeParameterAccess.getKey()

getIncludeReflectionParameters

public boolean getIncludeReflectionParameters()

Description copied from interface: JIPipeCustomParameterCollection

If true, also include parameters discovered via reflection. Custom parameters are added/override reflection parameters

Specified by:

getIncludeReflectionParameters in interface JIPipeCustomParameterCollection

Returns:

if parameters also should be discovered via reflection

getChildParameterCollections

public Map<String,JIPipeParameterCollection> getChildParameterCollections()

Description copied from interface: JIPipeCustomParameterCollection

Returns all sub-parameter collections

Specified by:

getChildParameterCollections in interface JIPipeCustomParameterCollection

Returns:

Map from unique collection ID to the collection.

getBatchGenerationSettings

public JIPipeMergingAlgorithmIterationStepGenerationSettings getBatchGenerationSettings()

Overrides:

getBatchGenerationSettings in class JIPipeGraphWrapperAlgorithm

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

getIterationMode

public JIPipeGraphWrapperAlgorithm.IterationMode getIterationMode()

Overrides:

getIterationMode in class JIPipeGraphWrapperAlgorithm

setIterationMode

public void setIterationMode(JIPipeGraphWrapperAlgorithm.IterationMode iterationMode)

Overrides:

setIterationMode in class JIPipeGraphWrapperAlgorithm