org.knime.core.node.workflow
Class PasteWorkflowContentPersistor

java.lang.Object
  org.knime.core.node.workflow.PasteWorkflowContentPersistor

All Implemented Interfaces:

NodeContainerPersistor, WorkflowPersistor

public class PasteWorkflowContentPersistor
extends Object
implements WorkflowPersistor

Persistor that is used to represent, for instance the clipboard content. It contains a list of nodes the connections connecting them. It does not support any of the "load" routines as it is an in-memory persistor. Instead it throws exceptions when any of the load routines are called.

Author:

Bernd Wiswedel, University of Konstanz

Nested Class Summary

Nested classes/interfaces inherited from interface org.knime.core.node.workflow.WorkflowPersistor

WorkflowPersistor.ConnectionContainerTemplate, WorkflowPersistor.LoadResult, WorkflowPersistor.LoadResultEntry, WorkflowPersistor.MetaNodeLinkUpdateResult, WorkflowPersistor.WorkflowLoadResult, WorkflowPersistor.WorkflowPortTemplate

Field Summary

Fields inherited from interface org.knime.core.node.workflow.WorkflowPersistor

KEY_CONNECTIONS, KEY_ID, KEY_NODES, KEY_UI_INFORMATION, METAINFO_FILE, SAVED_WITH_DATA_FILE, TEMPLATE_FILE, WORKFLOW_FILE

Constructor Summary

PasteWorkflowContentPersistor(Map<Integer,NodeContainerPersistor> loaderMap, Set<WorkflowPersistor.ConnectionContainerTemplate> connectionSet, Set<WorkflowPersistor.ConnectionContainerTemplate> additionalConnectionSet, WorkflowAnnotation[] copiedAnnotations, boolean isUndoableDeleteCommand)
Create new persistor.

Method Summary

InputStream	decipherInput(InputStream input) Open decryption stream for locked meta nodes.
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()
WorkflowPersistorVersion200.LoadVersion	getLoadVersion()
NodeContainerMetaPersistor	getMetaPersistor()
String	getName()
NodeContainer	getNodeContainer(WorkflowManager parent, NodeID id)
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()
WorkflowCipher	getWorkflowCipher()
List<FlowVariable>	getWorkflowVariables() Get the workflow variables associated with this meta node/workflow.
boolean	isDirtyAfterLoad()
void	loadNodeContainer(Map<Integer,BufferedDataTable> tblRep, ExecutionMonitor exec, WorkflowPersistor.LoadResult loadResult)
boolean	mustComplainIfStateDoesNotMatch() Does this persistor complain if its persisted state state does not match the state after loading (typically all non-executed nodes are configured after load).
boolean	mustWarnOnDataLoadError()
boolean	needsResetAfterLoad()
void	preLoadNodeContainer(WorkflowPersistor parentPersistor, NodeSettingsRO parentSettings, WorkflowPersistor.LoadResult loadResult)
protected void	throwUnsupportedOperationException() Throws a new exception with a meaningful error message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PasteWorkflowContentPersistor

PasteWorkflowContentPersistor(Map<Integer,NodeContainerPersistor> loaderMap,
                              Set<WorkflowPersistor.ConnectionContainerTemplate> connectionSet,
                              Set<WorkflowPersistor.ConnectionContainerTemplate> additionalConnectionSet,
                              WorkflowAnnotation[] copiedAnnotations,
                              boolean isUndoableDeleteCommand)

Create new persistor.

Parameters:

loaderMap - The loader map.

connectionSet - A copy of connection clones.

additionalConnectionSet - see getAdditionalConnectionSet()

copiedAnnotations - Copied workflow annotations.

isUndoableDeleteCommand - If false, annotations will be cloned in getWorkflowAnnotations().

Method Detail

getConnectionSet

public 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 WorkflowPersistor.getAdditionalConnectionSet()).

Specified by:

getConnectionSet in interface WorkflowPersistor

Returns:

The connections

getAdditionalConnectionSet

public 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).

Specified by:

getAdditionalConnectionSet in interface WorkflowPersistor

Returns:

Such a set (often empty but never null).

getGlobalTableRepository

public HashMap<Integer,ContainerTable> getGlobalTableRepository()

Specified by:

getGlobalTableRepository in interface WorkflowPersistor

getInPortTemplates

public WorkflowPersistor.WorkflowPortTemplate[] getInPortTemplates()

Specified by:

getInPortTemplates in interface WorkflowPersistor

getInPortsBarUIInfo

public UIInformation getInPortsBarUIInfo()

Get UI information for workflow input ports.

Specified by:

getInPortsBarUIInfo in interface WorkflowPersistor

Returns:

the ui info or null if not set.

getLoadVersion

public WorkflowPersistorVersion200.LoadVersion getLoadVersion()

Specified by:

getLoadVersion in interface WorkflowPersistor

getName

public String getName()

Specified by:

getName in interface WorkflowPersistor

getWorkflowCipher

public WorkflowCipher getWorkflowCipher()

Specified by:

getWorkflowCipher in interface WorkflowPersistor

Returns:

cipher associated with the metanode/workflow, often just WorkflowCipher.NULL_CIPHER, never null.

getTemplateInformation

public MetaNodeTemplateInformation getTemplateInformation()

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

Specified by:

getTemplateInformation in interface WorkflowPersistor

Returns:

The template info

getNodeLoaderMap

public Map<Integer,NodeContainerPersistor> getNodeLoaderMap()

The map of node ID suffix to persistor.

Specified by:

getNodeLoaderMap in interface WorkflowPersistor

Returns:

The persistor map.

getOutPortTemplates

public WorkflowPersistor.WorkflowPortTemplate[] getOutPortTemplates()

Specified by:

getOutPortTemplates in interface WorkflowPersistor

getOutPortsBarUIInfo

public UIInformation getOutPortsBarUIInfo()

Get UI information for workflow output ports.

Specified by:

getOutPortsBarUIInfo in interface WorkflowPersistor

Returns:

the ui info or null if not set.

getWorkflowVariables

public 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.

Specified by:

getWorkflowVariables in interface WorkflowPersistor

Returns:

The workflow variables.

getCredentials

public List<Credentials> getCredentials()

Get (non-null) map of credentials.

Specified by:

getCredentials in interface WorkflowPersistor

Returns:

The credentials defined on this meta node.

getWorkflowAnnotations

public List<WorkflowAnnotation> getWorkflowAnnotations()

Specified by:

getWorkflowAnnotations in interface WorkflowPersistor

Returns:

(non-mull) map of annotations.

getObsoleteNodeDirectories

public List<ReferencedFile> getObsoleteNodeDirectories()

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

Specified by:

getObsoleteNodeDirectories in interface WorkflowPersistor

Returns:

List of obsolete node directories

mustWarnOnDataLoadError

public boolean mustWarnOnDataLoadError()

Specified by:

mustWarnOnDataLoadError in interface WorkflowPersistor

Returns:

the shouldFailOnLoadDataError

getMetaPersistor

public NodeContainerMetaPersistor getMetaPersistor()

Specified by:

getMetaPersistor in interface NodeContainerPersistor

getNodeContainer

public NodeContainer getNodeContainer(WorkflowManager parent,
                                      NodeID id)

Specified by:

getNodeContainer in interface NodeContainerPersistor

isDirtyAfterLoad

public boolean isDirtyAfterLoad()

Specified by:

isDirtyAfterLoad in interface NodeContainerPersistor

loadNodeContainer

public void loadNodeContainer(Map<Integer,BufferedDataTable> tblRep,
                              ExecutionMonitor exec,
                              WorkflowPersistor.LoadResult loadResult)
                       throws InvalidSettingsException,
                              CanceledExecutionException,
                              IOException

Specified by:

loadNodeContainer in interface NodeContainerPersistor

Throws:

InvalidSettingsException

CanceledExecutionException

IOException

mustComplainIfStateDoesNotMatch

public boolean mustComplainIfStateDoesNotMatch()

Does this persistor complain if its persisted state state does not match the state after loading (typically all non-executed nodes are configured after load). This is true for all SingleNodeContainer and newer meta nodes, but it will be false for meta nodes, which are loaded from 1.x workflow.

Specified by:

mustComplainIfStateDoesNotMatch in interface NodeContainerPersistor

Returns:

Such a property.

needsResetAfterLoad

public boolean needsResetAfterLoad()

Specified by:

needsResetAfterLoad in interface NodeContainerPersistor

preLoadNodeContainer

public void preLoadNodeContainer(WorkflowPersistor parentPersistor,
                                 NodeSettingsRO parentSettings,
                                 WorkflowPersistor.LoadResult loadResult)
                          throws InvalidSettingsException,
                                 IOException

Specified by:

preLoadNodeContainer in interface NodeContainerPersistor

Throws:

InvalidSettingsException

IOException

decipherInput

public InputStream decipherInput(InputStream input)

Open decryption stream for locked meta nodes. Implementations will also call the decipher method on their parent workflow persistors.

Specified by:

decipherInput in interface WorkflowPersistor

Parameters:

input - The input to decipher.

Returns:

The decipherd input, mostly just the input.

throwUnsupportedOperationException

protected void throwUnsupportedOperationException()

Throws a new exception with a meaningful error message. It is called when a non supported method is invoked.