org.hkijena.jipipe.api.compartments.algorithms

Class JIPipeProjectCompartment

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

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

All Implemented Interfaces:

JIPipeValidatable, JIPipeCustomParameterCollection, JIPipeParameterCollection

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.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
JIPipeProjectCompartment(JIPipeNodeInfo info) Creates new instance
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.
JIPipeCompartmentOutput	getOutputNode()
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.
JIPipeProject	getProject()
UUID	getProjectCompartmentUUID()
boolean	isInitialized()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isShowLimitedParameters()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	run(JIPipeProgressInfo progressInfo) Runs the workload
void	setCustomName(String customName) Sets a custom name.
void	setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)
void	setOutputNode(JIPipeCompartmentOutput outputNode) Sets the compartment output.
void	setProject(JIPipeProject project) Sets the project.
void	setShowLimitedParameters(boolean showLimitedParameters)

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, getDependencies, 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, setBaseDirectory, setBookmarked, setCustomDescription, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, 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, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

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

generateValidityReport

Constructor Detail

JIPipeProjectCompartment

public JIPipeProjectCompartment(JIPipeNodeInfo info)

Creates new instance

Parameters:

info - Algorithm info

JIPipeProjectCompartment

public JIPipeProjectCompartment(JIPipeProjectCompartment other)

Copies the compartment

Parameters:

other - Original compartment

Method Detail

getProjectCompartmentUUID

public UUID getProjectCompartmentUUID()

Returns:

The compartment ID

isInitialized

public boolean isInitialized()

Returns:

If the compartment is initialized

setCustomName

public void setCustomName(String customName)

Description copied from class: JIPipeGraphNode

Sets a custom name. If set to null, the standard algorithm name is automatically used by getName()

Overrides:

setCustomName in class JIPipeGraphNode

Parameters:

customName - custom name

run

public void run(JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Specified by:

run in class JIPipeGraphNode

Parameters:

progressInfo - progress passed from the runner

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.

getProject

public JIPipeProject getProject()

Returns:

The project

setProject

public void setProject(JIPipeProject project)

Sets the project. Internal use only.

Parameters:

project - The project

getOutputNode

public JIPipeCompartmentOutput getOutputNode()

Returns:

The compartment output

setOutputNode

public void setOutputNode(JIPipeCompartmentOutput outputNode)

Sets the compartment output. Internal use only.

Parameters:

outputNode - the compartment output

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

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