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.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 SAVED_WITH_DATA_FILE
          File used to signal that workflow was saved in usual manner.
static String WORKFLOW_FILE
          Identifier for KNIME workflows when saved to disc.
 
Method Summary
 Set<WorkflowPersistor.ConnectionContainerTemplate> getConnectionSet()
           
 HashMap<Integer,ContainerTable> getGlobalTableRepository()
           
 UIInformation getInPortsBarUIInfo()
          Get UI information for workflow input ports.
 WorkflowPersistor.WorkflowPortTemplate[] getInPortTemplates()
           
 String getLoadVersion()
           
 String getName()
           
 Map<Integer,NodeContainerPersistor> getNodeLoaderMap()
           
 UIInformation getOutPortsBarUIInfo()
          Get UI information for workflow output ports.
 WorkflowPersistor.WorkflowPortTemplate[] getOutPortTemplates()
           
 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

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
Method Detail

getLoadVersion

String getLoadVersion()

getNodeLoaderMap

Map<Integer,NodeContainerPersistor> getNodeLoaderMap()

getConnectionSet

Set<WorkflowPersistor.ConnectionContainerTemplate> getConnectionSet()

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.

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


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.