org.hkijena.jipipe.api.grouping.parameters

Class GraphNodeParameterReferenceGroupCollection

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.grouping.parameters.GraphNodeParameterReferenceGroupCollection

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection

public class GraphNodeParameterReferenceGroupCollection
extends AbstractJIPipeParameterCollection
implements JIPipeValidatable

Contains a list of GraphNodeParameterReferenceGroup and GraphNodeParameterCollectionReference Stores references to parameters within an JIPipeGraph

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
GraphNodeParameterReferenceGroupCollection() Creates a new instance
GraphNodeParameterReferenceGroupCollection(GraphNodeParameterReferenceGroupCollection other) Makes a copy

Method Summary

Modifier and Type	Method and Description
void	addGroups(Collection<GraphNodeParameterReferenceGroup> groups) Adds multiple groups
GraphNodeParameterReferenceGroup	addNewGroup() Adds a new empty group
JIPipeGraph	getGraph() Returns the reference to the graph.
List<GraphNodeParameterReferenceGroup>	getParameterReferenceGroups()
Set<UUID>	getUiRestrictToCompartments()
void	onReferencesChanged(ParameterReferencesChangedEvent event) Triggered when some parameters were changed down the line
void	removeGroup(GraphNodeParameterReferenceGroup group) Removes the group
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setGraph(JIPipeGraph graph)
void	setParameterReferenceGroups(List<GraphNodeParameterReferenceGroup> parameterReferenceGroups)
void	setUiRestrictToCompartments(Set<UUID> uiRestrictToCompartments)

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getEventBus

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, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

GraphNodeParameterReferenceGroupCollection

public GraphNodeParameterReferenceGroupCollection()

Creates a new instance

GraphNodeParameterReferenceGroupCollection

public GraphNodeParameterReferenceGroupCollection(GraphNodeParameterReferenceGroupCollection other)

Makes a copy

Parameters:

other - the original

Method Detail

getGraph

public JIPipeGraph getGraph()

Returns the reference to the graph. This will be accessed by the editor component to pick new parameters and resolve them.

Returns:

reference to the graph if available

setGraph

public void setGraph(JIPipeGraph graph)

addNewGroup

public GraphNodeParameterReferenceGroup addNewGroup()

Adds a new empty group

Returns:

the group

addGroups

public void addGroups(Collection<GraphNodeParameterReferenceGroup> groups)

Adds multiple groups

Parameters:

groups - groups

getParameterReferenceGroups

public List<GraphNodeParameterReferenceGroup> getParameterReferenceGroups()

setParameterReferenceGroups

public void setParameterReferenceGroups(List<GraphNodeParameterReferenceGroup> parameterReferenceGroups)

onReferencesChanged

public void onReferencesChanged(ParameterReferencesChangedEvent event)

Triggered when some parameters were changed down the line

Parameters:

event - the event

removeGroup

public void removeGroup(GraphNodeParameterReferenceGroup group)

Removes the group

Parameters:

group - the group

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

report - the report to be added to

getUiRestrictToCompartments

public Set<UUID> getUiRestrictToCompartments()

setUiRestrictToCompartments

public void setUiRestrictToCompartments(Set<UUID> uiRestrictToCompartments)