org.hkijena.jipipe.api.compartments.algorithms

Class JIPipeProjectCompartment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.compartments.algorithms.JIPipeProjectCompartment

All Implemented Interfaces:

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

public class JIPipeProjectCompartment
extends JIPipeGraphNode
implements JIPipeCustomParameterCollection

A project compartment. Its node functionality is structural.

Nested Class Summary

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
JIPipeProjectCompartment(JIPipeNodeInfo info)
JIPipeProjectCompartment(JIPipeProjectCompartment other) Copies the compartment

Method Summary

Modifier and Type	Method and Description
Map<String,JIPipeParameterCollection>	getChildParameterCollections() Returns all sub-parameter collections
GraphNodeParameterReferenceGroupCollection	getExportedParameters()
boolean	getIncludeReflectionParameters() If true, also include parameters discovered via reflection.
JIPipeProjectCompartmentOutput	getOutputNode(String outputName)
com.google.common.collect.BiMap<String,JIPipeProjectCompartmentOutput>	getOutputNodes()
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.
UUID	getProjectCompartmentUUID()
OptionalColorParameter	getProjectOverviewColor()
JIPipeProject	getRuntimeProject() Returns the current project associated with the current run
List<JIPipeProjectCompartmentOutput>	getSortedOutputNodes()
boolean	isInitialized()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isShowInProjectOverview()
boolean	isShowLimitedParameters()
void	onSlotConfigurationChanged(JIPipeSlotConfiguration.SlotConfigurationChangedEvent event) Should be triggered when a slot is added to the slot configuration
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
void	setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)
void	setOutputNodes(com.google.common.collect.BiMap<String,JIPipeProjectCompartmentOutput> outputNodes)
void	setProjectOverviewColor(OptionalColorParameter projectOverviewColor)
void	setRuntimeProject(JIPipeProject runtimeProject) Sets the project.
void	setShowInProjectOverview(boolean showInProjectOverview)
void	setShowLimitedParameters(boolean showLimitedParameters)

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

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, createUIInputSlotIconDescriptionMenuItems, duplicate, emitNodeSlotsChangedEvent, fromJson, functionallyEquals, 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, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getTextDescription, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onDeserialized, onParameterChanged, renderInputSlots, renderOutputSlots, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setNodeUILocationPerViewModePerCompartment, setNodeUILocationWithin, setNodeUILocationWithin, setParentGraph, setProjectDirectory, 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.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.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

JIPipeProjectCompartment

public JIPipeProjectCompartment(JIPipeNodeInfo info)

JIPipeProjectCompartment

public JIPipeProjectCompartment(JIPipeProjectCompartment other)

Copies the compartment

Parameters:

other - Original compartment

Method Detail

getProjectOverviewColor

public OptionalColorParameter getProjectOverviewColor()

setProjectOverviewColor

public void setProjectOverviewColor(OptionalColorParameter projectOverviewColor)

getProjectCompartmentUUID

public UUID getProjectCompartmentUUID()

Returns:

The compartment ID

isInitialized

public boolean isInitialized()

Returns:

If the compartment is initialized

run

public void run(JIPipeGraphNodeRunContext runContext,
                JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Specified by:

run in class JIPipeGraphNode

Parameters:

runContext - the context of the run process

progressInfo - progress passed from the runner

onSlotConfigurationChanged

public void onSlotConfigurationChanged(JIPipeSlotConfiguration.SlotConfigurationChangedEvent event)

Description copied from class: JIPipeGraphNode

Should be triggered when a slot is added to the slot configuration

Specified by:

onSlotConfigurationChanged in interface JIPipeSlotConfiguration.SlotConfigurationChangedEventListener

Overrides:

onSlotConfigurationChanged in class JIPipeGraphNode

Parameters:

event - The event

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.

getRuntimeProject

public JIPipeProject getRuntimeProject()

Description copied from class: JIPipeGraphNode

Returns the current project associated with the current run

Overrides:

getRuntimeProject in class JIPipeGraphNode

Returns:

The project

setRuntimeProject

public void setRuntimeProject(JIPipeProject runtimeProject)

Sets the project. Internal use only.

Overrides:

setRuntimeProject in class JIPipeGraphNode

Parameters:

runtimeProject - The project

getOutputNode

public JIPipeProjectCompartmentOutput getOutputNode(String outputName)

getOutputNodes

public com.google.common.collect.BiMap<String,JIPipeProjectCompartmentOutput> getOutputNodes()

setOutputNodes

public void setOutputNodes(com.google.common.collect.BiMap<String,JIPipeProjectCompartmentOutput> outputNodes)

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

reportContext - the report context

report - the report to be added to

isShowInProjectOverview

public boolean isShowInProjectOverview()

setShowInProjectOverview

public void setShowInProjectOverview(boolean showInProjectOverview)

getExportedParameters

public GraphNodeParameterReferenceGroupCollection getExportedParameters()

setExportedParameters

public void setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)

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 JIPipeGraphNode

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

getSortedOutputNodes

public List<JIPipeProjectCompartmentOutput> getSortedOutputNodes()