org.hkijena.jipipe.api.grouping

Class NodeGroup

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.grouping.GraphWrapperAlgorithm

org.hkijena.jipipe.api.grouping.NodeGroup

All Implemented Interfaces:

JIPipeValidatable, JIPipeDataBatchAlgorithm, JIPipeCustomParameterCollection, JIPipeParameterCollection

public class NodeGroup
extends GraphWrapperAlgorithm
implements JIPipeCustomParameterCollection

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

GraphWrapperAlgorithm.IterationMode, GraphWrapperAlgorithm.IterationModeEnumInfo

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

Method Summary

Modifier and Type	Method and Description
BiMap<JIPipeDataSlot,JIPipeDataSlot>	autoCreateSlots() Automatically creates slots that connect all inputs
JIPipeMergingAlgorithmDataBatchGenerationSettings	getBatchGenerationSettings()
Map<String,JIPipeParameterCollection>	getChildParameterCollections() Returns all sub-parameter collections
NodeGroupContents	getContents()
GraphNodeParameterReferenceGroupCollection	getExportedParameters()
boolean	getIncludeReflectionParameters() If true, also include parameters discovered via reflection.
GraphWrapperAlgorithm.IterationMode	getIterationMode()
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.
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(JIPipeIssueReport report) Generates a validity report
void	setContents(NodeGroupContents contents)
void	setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)
void	setIterationMode(GraphWrapperAlgorithm.IterationMode iterationMode)
void	setShowLimitedParameters(boolean showLimitedParameters)

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

generateDataBatchesDryRun, getDependencies, getGenerationSettingsInterface, getGroupInput, getGroupOutput, getWrappedGraph, isPreventUpdateSlots, run, setBaseDirectory, setInternalStoragePath, setPreventUpdateSlots, setProjectDirectory, setScratchBaseDirectory, setWrappedGraph, updateGroupSlots

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, 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, setBookmarked, setCustomDescription, setCustomName, setInfo, setLocations, setLocationWithin, setLocationWithin, setParentGraph, 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.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getEventBus, getParameter, getParameterAccess, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Constructor Detail

NodeGroup

public NodeGroup(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

NodeGroup

public NodeGroup(NodeGroup other)

Creates a copy

Parameters:

other - the original

NodeGroup

public NodeGroup(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 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

getContents

public NodeGroupContents getContents()

setContents

public void setContents(NodeGroupContents contents)

getExportedParameters

public GraphNodeParameterReferenceGroupCollection getExportedParameters()

setExportedParameters

public void setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)

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 GraphWrapperAlgorithm

Parameters:

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)

getBatchGenerationSettings

public JIPipeMergingAlgorithmDataBatchGenerationSettings getBatchGenerationSettings()

Overrides:

getBatchGenerationSettings in class GraphWrapperAlgorithm

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

getIterationMode

public GraphWrapperAlgorithm.IterationMode getIterationMode()

Overrides:

getIterationMode in class GraphWrapperAlgorithm

setIterationMode

public void setIterationMode(GraphWrapperAlgorithm.IterationMode iterationMode)

Overrides:

setIterationMode in class GraphWrapperAlgorithm