org.knime.core.node.workflow
Interface NodeContainerMetaPersistor

All Known Implementing Classes:

CopyNodeContainerMetaPersistor, NodeContainerMetaPersistorVersion1xx, NodeContainerMetaPersistorVersion200

interface NodeContainerMetaPersistor

Field Summary

static String	KEY_CUSTOM_DESCRIPTION Key for this node's custom description.
static String	KEY_CUSTOM_NAME Key for this node's user name.

Method Summary

String	getCustomDescription()
NodeExecutionJobManager	getExecutionJobManager()
NodeSettingsRO	getExecutionJobSettings()
WorkflowLoadHelper	getLoadHelper()
NodeAnnotationData	getNodeAnnotationData()
ReferencedFile	getNodeContainerDirectory() File reference to the node container directory.
int	getNodeIDSuffix()
NodeMessage	getNodeMessage()
NodeContainer.State	getState()
NodeUIInformation	getUIInfo()
boolean	isDeletable()
boolean	isDirtyAfterLoad()
boolean	load(NodeSettingsRO settings, NodeSettingsRO parentSettings, WorkflowPersistor.LoadResult loadResult) Load content, gets both the current settings (first argument) and the "parent settings", which are only used in 1.3.x flows and will be ignored in any version after that.
void	setNodeIDSuffix(int nodeIDSuffix)
void	setUIInfo(NodeUIInformation uiInfo)

Field Detail

KEY_CUSTOM_DESCRIPTION

static final String KEY_CUSTOM_DESCRIPTION

Key for this node's custom description.

See Also:

Constant Field Values

KEY_CUSTOM_NAME

static final String KEY_CUSTOM_NAME

Key for this node's user name.

See Also:

Constant Field Values

Method Detail

getLoadHelper

WorkflowLoadHelper getLoadHelper()

Returns:

the load helper as set during load (not part of the workflow being loaded but a setting during load).

getNodeContainerDirectory

ReferencedFile getNodeContainerDirectory()

File reference to the node container directory. Something like <workflow_space>/File Reader (#xy). This value is non-null when (i) loading from disk or (ii) if pasted into a workflow as part of an undo of a delete command. It's null if node is copied&pasted. If the value is non-null the referenced file will be removed from the list of obsolete node directories (must not clear directories as they may contain a "drop" folder).

Returns:

The node container dir or null

getNodeIDSuffix

int getNodeIDSuffix()

setNodeIDSuffix

void setNodeIDSuffix(int nodeIDSuffix)

getNodeAnnotationData

NodeAnnotationData getNodeAnnotationData()

getCustomDescription

String getCustomDescription()

getExecutionJobManager

NodeExecutionJobManager getExecutionJobManager()

getExecutionJobSettings

NodeSettingsRO getExecutionJobSettings()

getState

NodeContainer.State getState()

getUIInfo

NodeUIInformation getUIInfo()

getNodeMessage

NodeMessage getNodeMessage()

isDeletable

boolean isDeletable()

isDirtyAfterLoad

boolean isDirtyAfterLoad()

setUIInfo

void setUIInfo(NodeUIInformation uiInfo)

load

boolean load(NodeSettingsRO settings,
             NodeSettingsRO parentSettings,
             WorkflowPersistor.LoadResult loadResult)

Load content, gets both the current settings (first argument) and the "parent settings", which are only used in 1.3.x flows and will be ignored in any version after that.

Parameters:

settings - The settings object that is usually read from

parentSettings - The parent settings, mostly ignored.

loadResult - Where to add errors and warnings to.

Returns:

Whether errors occurred that require a reset of the node.