org.knime.core.node.workflow
Interface WorkflowPersistor

All Superinterfaces:

NodeContainerPersistor

All Known Implementing Classes:

CopyWorkflowPersistor, InsertWorkflowPersistor, ObsoleteMetaNodeWorkflowPersistorVersion1xx, PasteWorkflowContentPersistor, WorkflowPersistorVersion1xx, WorkflowPersistorVersion200

public interface WorkflowPersistor
extends NodeContainerPersistor

Author:

Bernd Wiswedel, University of Konstanz

Nested Class Summary

static class	WorkflowPersistor.ConnectionContainerTemplate Helper class representing a connection.
static class	WorkflowPersistor.LoadResult
static class	WorkflowPersistor.LoadResultEntry
static class	WorkflowPersistor.MetaNodeLinkUpdateResult
static class	WorkflowPersistor.WorkflowLoadResult
static class	WorkflowPersistor.WorkflowPortTemplate

Field Summary

static String	KEY_CONNECTIONS Key for connections.
static String	KEY_ID Key for this node's internal ID.
static String	KEY_NODES Key for nodes.
static String	KEY_UI_INFORMATION
static String	METAINFO_FILE Constant for the meta info file name.
static String	SAVED_WITH_DATA_FILE File used to signal that workflow was saved in usual manner.
static String	TEMPLATE_FILE Identifier for KNIME meta mode templates when saved to disc.
static String	WORKFLOW_FILE Identifier for KNIME workflows when saved to disc.

Method Summary

Set<WorkflowPersistor.ConnectionContainerTemplate>	getAdditionalConnectionSet() Get additional connections.
Set<WorkflowPersistor.ConnectionContainerTemplate>	getConnectionSet() The connections between the nodes that are loaded.
List<Credentials>	getCredentials() Get (non-null) map of credentials.
HashMap<Integer,ContainerTable>	getGlobalTableRepository()
UIInformation	getInPortsBarUIInfo() Get UI information for workflow input ports.
WorkflowPersistor.WorkflowPortTemplate[]	getInPortTemplates()
String	getLoadVersionString()
String	getName()
Map<Integer,NodeContainerPersistor>	getNodeLoaderMap() The map of node ID suffix to persistor.
List<ReferencedFile>	getObsoleteNodeDirectories() List of node directories, whose corresponding nodes failed to load.
UIInformation	getOutPortsBarUIInfo() Get UI information for workflow output ports.
WorkflowPersistor.WorkflowPortTemplate[]	getOutPortTemplates()
MetaNodeTemplateInformation	getTemplateInformation() template information associated with the workflow, e.g.
List<WorkflowAnnotation>	getWorkflowAnnotations()
List<FlowVariable>	getWorkflowVariables() Get the workflow variables associated with this meta node/workflow.
boolean	mustWarnOnDataLoadError()

Methods inherited from interface org.knime.core.node.workflow.NodeContainerPersistor

getMetaPersistor, getNodeContainer, isDirtyAfterLoad, loadNodeContainer, mustComplainIfStateDoesNotMatch, needsResetAfterLoad, preLoadNodeContainer

Field Detail

KEY_NODES

static final String KEY_NODES

Key for nodes.

See Also:

Constant Field Values

KEY_CONNECTIONS

static final String KEY_CONNECTIONS

Key for connections.

See Also:

Constant Field Values

KEY_UI_INFORMATION

static final String KEY_UI_INFORMATION

See Also:

Constant Field Values

KEY_ID

static final String KEY_ID

Key for this node's internal ID.

See Also:

Constant Field Values

WORKFLOW_FILE

static final String WORKFLOW_FILE

Identifier for KNIME workflows when saved to disc.

See Also:

Constant Field Values

TEMPLATE_FILE

static final String TEMPLATE_FILE

Identifier for KNIME meta mode templates when saved to disc.

See Also:

Constant Field Values

SAVED_WITH_DATA_FILE

static final String SAVED_WITH_DATA_FILE

File used to signal that workflow was saved in usual manner. It will always be present in the workflow directory unless the workflow is exported with the "exclude data" flag being set.

See Also:

Constant Field Values

METAINFO_FILE

static final String METAINFO_FILE

Constant for the meta info file name.

See Also:

Constant Field Values

Method Detail

getLoadVersionString

String getLoadVersionString()

getNodeLoaderMap

Map<Integer,NodeContainerPersistor> getNodeLoaderMap()

The map of node ID suffix to persistor.

Returns:

The persistor map.

getConnectionSet

Set<WorkflowPersistor.ConnectionContainerTemplate> getConnectionSet()

The connections between the nodes that are loaded. The set only contains connections between nodes of the loader map, it does not contain any other connection (see getAdditionalConnectionSet()).

Returns:

The connections

getAdditionalConnectionSet

Set<WorkflowPersistor.ConnectionContainerTemplate> getAdditionalConnectionSet()

Get additional connections. These are connections that connect nodes that were loaded to nodes that are already in the workflow. In most cases this list is empty except for undo commands that restore deleted nodes (and their connections to other nodes in the workflow).

Returns:

Such a set (often empty but never null).

getGlobalTableRepository

HashMap<Integer,ContainerTable> getGlobalTableRepository()

getName

String getName()

getWorkflowVariables

List<FlowVariable> getWorkflowVariables()

Get the workflow variables associated with this meta node/workflow. This method must not return null (but possibly an empty list). The result may be unmodifiable.

Returns:

The workflow variables.

getCredentials

List<Credentials> getCredentials()

Get (non-null) map of credentials.

Returns:

The credentials defined on this meta node.

getWorkflowAnnotations

List<WorkflowAnnotation> getWorkflowAnnotations()

Returns:

(non-mull) map of annotations.

getObsoleteNodeDirectories

List<ReferencedFile> getObsoleteNodeDirectories()

List of node directories, whose corresponding nodes failed to load. These directories will be deleted in the next save invocation.

Returns:

List of obsolete node directories

getInPortTemplates

WorkflowPersistor.WorkflowPortTemplate[] getInPortTemplates()

getOutPortTemplates

WorkflowPersistor.WorkflowPortTemplate[] getOutPortTemplates()

getInPortsBarUIInfo

UIInformation getInPortsBarUIInfo()

Get UI information for workflow input ports.

Returns:

the ui info or null if not set.

getOutPortsBarUIInfo

UIInformation getOutPortsBarUIInfo()

Get UI information for workflow output ports.

Returns:

the ui info or null if not set.

mustWarnOnDataLoadError

boolean mustWarnOnDataLoadError()

Returns:

the shouldFailOnLoadDataError

getTemplateInformation

MetaNodeTemplateInformation getTemplateInformation()

template information associated with the workflow, e.g. whether it is linking to same central master meta node.

Returns:

The template info