org.hkijena.jipipe.api.grouping

Class JIPipeNodeGroup

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

All Implemented Interfaces:

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

public class JIPipeNodeGroup
extends JIPipeGraphWrapperAlgorithm
implements JIPipeCustomParameterCollection, ParameterReferencesChangedEventListener

A sub-graph algorithm that can be defined by a user

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
JIPipeNodeGroup(JIPipeGraph graph, boolean autoCreateSlots, boolean clearLocations, boolean fixLocations) Initializes from an existing graph
JIPipeNodeGroup(JIPipeNodeGroup other) Creates a copy
JIPipeNodeGroup(JIPipeNodeInfo info) Creates a new instance

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.BiMap<JIPipeDataSlot,JIPipeDataSlot>	autoCreateSlots() Automatically creates slots that connect all inputs
JIPipeMergingAlgorithmIterationStepGenerationSettings	getBatchGenerationSettings()
Map<String,JIPipeParameterCollection>	getChildParameterCollections() Returns all sub-parameter collections
NodeGroupContents	getContents()
JIPipeGraphRunPartitionInheritedBoolean	getContinueOnFailureExportFailedInputs()
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.
JIPipeGraphRunPartitionInheritedBoolean	isContinueOnFailure()
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
boolean	isShowLimitedParameters()
void	onParameterReferencesChanged(ParameterReferencesChangedEvent event)
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setContents(NodeGroupContents contents)
void	setContinueOnFailure(JIPipeGraphRunPartitionInheritedBoolean continueOnFailure)
void	setContinueOnFailureExportFailedInputs(JIPipeGraphRunPartitionInheritedBoolean continueOnFailureExportFailedInputs)
void	setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)
void	setIterationMode(JIPipeGraphWrapperAlgorithm.IterationMode iterationMode)
void	setShowLimitedParameters(boolean showLimitedParameters)

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

generateDataBatchesGenerationResult, getContinueOnFailure, getDependencies, getGenerationSettingsInterface, getGroupInput, getGroupOutput, getWrappedGraph, isPreventUpdateSlots, run, setBaseDirectory, setBatchGenerationSettings, setInternalStoragePath, setPreventUpdateSlots, setProjectDirectory, setRuntimeProject, setScratchBaseDirectory, setWrappedGraph, updateGroupSlots

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, 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, 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

JIPipeNodeGroup

public JIPipeNodeGroup(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

JIPipeNodeGroup

public JIPipeNodeGroup(JIPipeNodeGroup other)

Creates a copy

Parameters:

other - the original

JIPipeNodeGroup

public JIPipeNodeGroup(JIPipeGraph graph,
                       boolean autoCreateSlots,
                       boolean clearLocations,
                       boolean fixLocations)

Initializes from an existing graph

Parameters:

graph - algorithms to be added

autoCreateSlots - automatically create input and output slots

clearLocations - if enabled, clear the locations. if false, fixLocations will be queried

fixLocations - if enabled, move group inputs/outputs to locations where they fit better

Method Detail

autoCreateSlots

public com.google.common.collect.BiMap<JIPipeDataSlot,JIPipeDataSlot> autoCreateSlots()

Automatically creates slots that connect all inputs

Returns:

Map from a slot in the wrapped graph to the exported group slot

isContinueOnFailure

public JIPipeGraphRunPartitionInheritedBoolean isContinueOnFailure()

Overrides:

isContinueOnFailure in class JIPipeGraphWrapperAlgorithm

setContinueOnFailure

public void setContinueOnFailure(JIPipeGraphRunPartitionInheritedBoolean continueOnFailure)

Overrides:

setContinueOnFailure in class JIPipeGraphWrapperAlgorithm

getContinueOnFailureExportFailedInputs

public JIPipeGraphRunPartitionInheritedBoolean getContinueOnFailureExportFailedInputs()

Overrides:

getContinueOnFailureExportFailedInputs in class JIPipeGraphWrapperAlgorithm

setContinueOnFailureExportFailedInputs

public void setContinueOnFailureExportFailedInputs(JIPipeGraphRunPartitionInheritedBoolean continueOnFailureExportFailedInputs)

Overrides:

setContinueOnFailureExportFailedInputs in class JIPipeGraphWrapperAlgorithm

getContents

public NodeGroupContents getContents()

setContents

public void setContents(NodeGroupContents contents)

getExportedParameters

public GraphNodeParameterReferenceGroupCollection getExportedParameters()

setExportedParameters

public void setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)

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 JIPipeGraphWrapperAlgorithm

Parameters:

reportContext - the report context

report - the report to be added to

isShowLimitedParameters

public boolean isShowLimitedParameters()

setShowLimitedParameters

public void setShowLimitedParameters(boolean showLimitedParameters)

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

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.

onParameterReferencesChanged

public void onParameterReferencesChanged(ParameterReferencesChangedEvent event)

Specified by:

onParameterReferencesChanged in interface ParameterReferencesChangedEventListener

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