org.knime.core.node.workflow
Class WorkflowPersistorVersion200

java.lang.Object
  org.knime.core.node.workflow.WorkflowPersistorVersion1xx
      org.knime.core.node.workflow.WorkflowPersistorVersion200

All Implemented Interfaces:

NodeContainerPersistor, WorkflowPersistor

public class WorkflowPersistorVersion200
extends WorkflowPersistorVersion1xx

Author:

Bernd Wiswedel, University of Konstanz

Nested Class Summary

static class

WorkflowPersistorVersion200.LoadVersion A Version representing a specific workflow format.

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

(package private) static WorkflowPersistorVersion200.LoadVersion

VERSION_LATEST

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

WorkflowPersistorVersion200(HashMap<Integer,ContainerTable> tableRep, ReferencedFile workflowKNIMEFile, WorkflowLoadHelper loadHelper, WorkflowPersistorVersion200.LoadVersion version)
Create persistor for load.

Method Summary

(package private) static WorkflowPersistorVersion200.LoadVersion	canReadVersionV200(String versionString)
protected SingleNodeContainerPersistorVersion200	createSingleNodeContainerPersistorLoad(ReferencedFile nodeFile)
protected WorkflowPersistorVersion200	createWorkflowPersistorLoad(ReferencedFile wfmFile)
protected void	fixDestPortIfNecessary(NodeContainerPersistor destPersistor, WorkflowPersistor.ConnectionContainerTemplate c) Fixes destination port index if necessary.
protected void	fixSourcePortIfNecessary(NodeContainerPersistor sourcePersistor, WorkflowPersistor.ConnectionContainerTemplate c) Fixes source port index if necessary.
protected static WorkflowPersistorVersion200.LoadVersion	getSaveVersion()
protected int	loadConnectionDestID(NodeSettingsRO settings)
protected int	loadConnectionDestPort(NodeSettingsRO settings)
protected List<Credentials>	loadCredentials(NodeSettingsRO settings) Loads credentials, this method returns an empty list.
protected boolean	loadIfMustWarnOnDataLoadError(File workflowDir) Sub class hook to check whether there is a "loaded with no data" file.
protected void	loadInPortsBarUIInfo(UIInformation uiInfo, NodeSettingsRO settings) Sub-class hook to load port bar info.
protected String	loadInPortsBarUIInfoClassName(NodeSettingsRO settings) Sub class hook o read port bar info.
protected NodeSettingsRO	loadInPortsSetting(NodeSettingsRO settings) Sub class hook o read port settings.
protected NodeSettingsRO	loadInPortsSettingsEnum(NodeSettingsRO settings) Sub class hook o read port settings.
protected WorkflowPersistor.WorkflowPortTemplate	loadInPortTemplate(NodeSettingsRO settings) Sub class hook o read port settings.
protected boolean	loadIsMetaNode(NodeSettingsRO settings)
protected void	loadOutPortsBarUIInfo(UIInformation uiInfo, NodeSettingsRO settings) Load output port bars.
protected String	loadOutPortsBarUIInfoClassName(NodeSettingsRO settings) Sub-class hook to load port bar info.
protected NodeSettingsRO	loadOutPortsSetting(NodeSettingsRO settings) Sub class hook o read port settings.
protected NodeSettingsRO	loadOutPortsSettingsEnum(NodeSettingsRO settings) Sub class hook o read port settings.
protected WorkflowPersistor.WorkflowPortTemplate	loadOutPortTemplate(NodeSettingsRO settings) Sub class hook o read port settings.
protected MetaNodeTemplateInformation	loadTemplateInformation(NodeSettingsRO settings) Load template information (in this version always MetaNodeTemplateInformation.NONE).
protected String	loadUIInfoClassName(NodeSettingsRO settings)
protected void	loadUIInfoSettings(UIInformation uiInfo, NodeSettingsRO settings)
protected List<WorkflowAnnotation>	loadWorkflowAnnotations(NodeSettingsRO settings) Load annotations (added in v2.3).
protected WorkflowCipher	loadWorkflowCipher(WorkflowPersistorVersion200.LoadVersion loadVersion, NodeSettingsRO settings)
protected String	loadWorkflowName(NodeSettingsRO set) Sub class hook o read workflow name.
List<FlowVariable>	loadWorkflowVariables(NodeSettingsRO settings) Load workflow variables (not available in 1.3.x flows).
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).
protected NodeSettingsRO	readParentSettings()
static String	save(WorkflowManager wm, ReferencedFile workflowDirRef, ExecutionMonitor execMon, boolean isSaveData)
protected static void	saveConnection(NodeSettingsWO settings, ConnectionContainer connection)
protected static void	saveCredentials(WorkflowManager wfm, NodeSettingsWO settings)
protected static void	saveFileLocation(NodeSettingsWO settings, String location)
protected static void	saveInPort(NodeSettingsWO settings, WorkflowManager wm, int portIndex)
protected static void	saveInportsBarUIInfoClassName(NodeSettingsWO settings, UIInformation info)
protected static void	saveInportsBarUIInfoSettings(NodeSettingsWO settings, UIInformation uiInfo)
protected static NodeSettingsWO	saveInPortsEnumSetting(NodeSettingsWO settings)
protected static NodeSettingsWO	saveInPortSetting(NodeSettingsWO settings, int portIndex)
protected static NodeSettingsWO	saveInPortsSetting(NodeSettingsWO settings)
protected static void	saveIsMeta(NodeSettingsWO settings, NodeContainer nc)
protected static void	saveNodeContainer(NodeSettingsWO settings, ReferencedFile workflowDirRef, NodeContainer container, ExecutionMonitor exec, boolean isSaveData)
protected static void	saveNodeIDSuffix(NodeSettingsWO settings, NodeContainer nc)
protected static void	saveOutPort(NodeSettingsWO settings, WorkflowManager wm, int portIndex)
protected static void	saveOutportsBarUIInfoClassName(NodeSettingsWO settings, UIInformation info)
protected static void	saveOutportsBarUIInfoSettings(NodeSettingsWO settings, UIInformation uiInfo)
protected static NodeSettingsWO	saveOutPortsEnumSetting(NodeSettingsWO settings)
protected static NodeSettingsWO	saveOutPortSetting(NodeSettingsWO settings, int portIndex)
protected static NodeSettingsWO	saveOutPortsSetting(NodeSettingsWO settings)
protected static NodeSettingsWO	saveSettingsForConnections(NodeSettingsWO settings) Save connections in an own sub-config object.
protected static NodeSettingsWO	saveSettingsForNodes(NodeSettingsWO settings) Save nodes in an own sub-config object as a series of configs.
protected static void	saveTemplateInformation(MetaNodeTemplateInformation mnti, NodeSettingsWO settings)
protected static void	saveUIInfoClassName(NodeSettingsWO settings, UIInformation info)
protected static void	saveUIInfoSettings(NodeSettingsWO settings, UIInformation uiInfo)
protected static void	saveWorkflowAnnotations(WorkflowManager manager, NodeSettingsWO settings)
protected static void	saveWorkflowCipher(NodeSettings settings, WorkflowCipher workflowCipher) Metanode locking information.
protected static void	saveWorkflowName(NodeSettingsWO settings, String name)
protected static void	saveWorkflowVariables(WorkflowManager wfm, NodeSettingsWO settings)

Methods inherited from class org.knime.core.node.workflow.WorkflowPersistorVersion1xx

canReadVersionV1X0, decipherInput, fixTemplateInformation, fixUIInfoClassName, getAdditionalConnectionSet, getConnectionSet, getCredentials, getGlobalTableRepository, getInPortsBarUIInfo, getInPortTemplates, getLoadHelper, getLoadVersion, getLogger, getMetaPersistor, getName, getNodeContainer, getNodeLoaderMap, getObsoleteNodeDirectories, getOutPortsBarUIInfo, getOutPortTemplates, getTemplateInformation, getWorkflowAnnotations, getWorkflowCipher, getWorkflowKNIMEFile, getWorkflowVariables, isDirtyAfterLoad, loadConnection, loadConnectionSourcePort, loadNodeContainer, loadNodeFile, loadNodeIDSuffix, loadSettingsForConnections, loadSettingsForNodes, loadUIInfoInstance, mustWarnOnDataLoadError, needsResetAfterLoad, preLoadNodeContainer, setDirtyAfterLoad, setNameOverwrite, setNeedsResetAfterLoad, setTemplateInformationLinkURI, shouldSkipThisNode

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_LATEST

static final WorkflowPersistorVersion200.LoadVersion VERSION_LATEST

Constructor Detail

WorkflowPersistorVersion200

WorkflowPersistorVersion200(HashMap<Integer,ContainerTable> tableRep,
                            ReferencedFile workflowKNIMEFile,
                            WorkflowLoadHelper loadHelper,
                            WorkflowPersistorVersion200.LoadVersion version)

Create persistor for load.

Parameters:

tableRep - Table repository

workflowKNIMEFile - workflow.knime or template.knime file

loadHelper - As required by meta persistor.

version - Version must pass canReadVersionV200(String).

Throws:

IllegalStateException - If version string is unsupported.

Method Detail

canReadVersionV200

static WorkflowPersistorVersion200.LoadVersion canReadVersionV200(String versionString)

getSaveVersion

protected static WorkflowPersistorVersion200.LoadVersion getSaveVersion()

Returns:

version that is saved, .

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

Overrides:

mustComplainIfStateDoesNotMatch in class WorkflowPersistorVersion1xx

Returns:

Such a property.

loadWorkflowVariables

public List<FlowVariable> loadWorkflowVariables(NodeSettingsRO settings)
                                         throws InvalidSettingsException

Load workflow variables (not available in 1.3.x flows).

Overrides:

loadWorkflowVariables in class WorkflowPersistorVersion1xx

Parameters:

settings - To load from.

Returns:

The variables in a list.

Throws:

InvalidSettingsException - If any settings-related error occurs.

loadCredentials

protected List<Credentials> loadCredentials(NodeSettingsRO settings)
                                     throws InvalidSettingsException

Loads credentials, this method returns an empty list. Credentials added for v2.2

Overrides:

loadCredentials in class WorkflowPersistorVersion1xx

Parameters:

settings - to load from.

Returns:

the credentials list

Throws:

InvalidSettingsException - If this fails for any reason.

loadWorkflowAnnotations

protected List<WorkflowAnnotation> loadWorkflowAnnotations(NodeSettingsRO settings)
                                                    throws InvalidSettingsException

Load annotations (added in v2.3).

Overrides:

loadWorkflowAnnotations in class WorkflowPersistorVersion1xx

Parameters:

settings - to load from

Returns:

non-null list.

Throws:

InvalidSettingsException - If this fails for any reason.

loadWorkflowName

protected String loadWorkflowName(NodeSettingsRO set)
                           throws InvalidSettingsException

Sub class hook o read workflow name.

Overrides:

loadWorkflowName in class WorkflowPersistorVersion1xx

Parameters:

set - Ignored.

Returns:

"Workflow Manager"

Throws:

InvalidSettingsException - Not actually thrown here.

loadWorkflowCipher

protected WorkflowCipher loadWorkflowCipher(WorkflowPersistorVersion200.LoadVersion loadVersion,
                                            NodeSettingsRO settings)
                                     throws InvalidSettingsException

Overrides:

loadWorkflowCipher in class WorkflowPersistorVersion1xx

Throws:

InvalidSettingsException

loadTemplateInformation

protected MetaNodeTemplateInformation loadTemplateInformation(NodeSettingsRO settings)
                                                       throws InvalidSettingsException

Load template information (in this version always MetaNodeTemplateInformation.NONE).

Overrides:

loadTemplateInformation in class WorkflowPersistorVersion1xx

Parameters:

settings - To load from

Returns:

MetaNodeTemplateInformation#NONE

Throws:

InvalidSettingsException - If fails

readParentSettings

protected NodeSettingsRO readParentSettings()

Overrides:

readParentSettings in class WorkflowPersistorVersion1xx

loadIsMetaNode

protected boolean loadIsMetaNode(NodeSettingsRO settings)
                          throws InvalidSettingsException

Overrides:

loadIsMetaNode in class WorkflowPersistorVersion1xx

Throws:

InvalidSettingsException

loadUIInfoClassName

protected String loadUIInfoClassName(NodeSettingsRO settings)
                              throws InvalidSettingsException

Overrides:

loadUIInfoClassName in class WorkflowPersistorVersion1xx

Throws:

InvalidSettingsException

loadUIInfoSettings

protected void loadUIInfoSettings(UIInformation uiInfo,
                                  NodeSettingsRO settings)
                           throws InvalidSettingsException

Overrides:

loadUIInfoSettings in class WorkflowPersistorVersion1xx

Throws:

InvalidSettingsException

loadConnectionDestID

protected int loadConnectionDestID(NodeSettingsRO settings)
                            throws InvalidSettingsException

Overrides:

loadConnectionDestID in class WorkflowPersistorVersion1xx

Throws:

InvalidSettingsException

loadConnectionDestPort

protected int loadConnectionDestPort(NodeSettingsRO settings)
                              throws InvalidSettingsException

Overrides:

loadConnectionDestPort in class WorkflowPersistorVersion1xx

Throws:

InvalidSettingsException

fixDestPortIfNecessary

protected void fixDestPortIfNecessary(NodeContainerPersistor destPersistor,
                                      WorkflowPersistor.ConnectionContainerTemplate c)

Fixes destination port index if necessary. For v1.x flows, e.g., the indices of model and data ports were swapped. Subclasses will overwrite this method (e.g. to enable loading flows, which did not have the mandatory flow variable port object).

Overrides:

fixDestPortIfNecessary in class WorkflowPersistorVersion1xx

Parameters:

destPersistor - The persistor of the destination node.

c - The connection template to be fixed.

fixSourcePortIfNecessary

protected void fixSourcePortIfNecessary(NodeContainerPersistor sourcePersistor,
                                        WorkflowPersistor.ConnectionContainerTemplate c)

Fixes source port index if necessary. Fixes the mandatory flow variable port object.

Overrides:

fixSourcePortIfNecessary in class WorkflowPersistorVersion1xx

Parameters:

sourcePersistor - The persistor of the source node.

c - The connection template to be fixed.

loadInPortsSetting

protected NodeSettingsRO loadInPortsSetting(NodeSettingsRO settings)
                                     throws InvalidSettingsException

Description copied from class: WorkflowPersistorVersion1xx

Sub class hook o read port settings.

Overrides:

loadInPortsSetting in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadInPortsSettingsEnum

protected NodeSettingsRO loadInPortsSettingsEnum(NodeSettingsRO settings)
                                          throws InvalidSettingsException

Sub class hook o read port settings.

Overrides:

loadInPortsSettingsEnum in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadInPortTemplate

protected WorkflowPersistor.WorkflowPortTemplate loadInPortTemplate(NodeSettingsRO settings)
                                                             throws InvalidSettingsException

Sub class hook o read port settings.

Overrides:

loadInPortTemplate in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadInPortsBarUIInfoClassName

protected String loadInPortsBarUIInfoClassName(NodeSettingsRO settings)
                                        throws InvalidSettingsException

Sub class hook o read port bar info.

Overrides:

loadInPortsBarUIInfoClassName in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadInPortsBarUIInfo

protected void loadInPortsBarUIInfo(UIInformation uiInfo,
                                    NodeSettingsRO settings)
                             throws InvalidSettingsException

Sub-class hook to load port bar info.

Overrides:

loadInPortsBarUIInfo in class WorkflowPersistorVersion1xx

Parameters:

uiInfo - Ignored.

settings - Ignored.

Throws:

InvalidSettingsException - Not actually thrown

loadOutPortsBarUIInfoClassName

protected String loadOutPortsBarUIInfoClassName(NodeSettingsRO settings)
                                         throws InvalidSettingsException

Sub-class hook to load port bar info.

Overrides:

loadOutPortsBarUIInfoClassName in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown

loadOutPortsBarUIInfo

protected void loadOutPortsBarUIInfo(UIInformation uiInfo,
                                     NodeSettingsRO settings)
                              throws InvalidSettingsException

Load output port bars. This implementation does nothing, sub-classes override this method.

Overrides:

loadOutPortsBarUIInfo in class WorkflowPersistorVersion1xx

Parameters:

uiInfo - Ignored here.

settings - Ignored here.

Throws:

InvalidSettingsException - Not actually thrown here.

loadOutPortsSetting

protected NodeSettingsRO loadOutPortsSetting(NodeSettingsRO settings)
                                      throws InvalidSettingsException

Description copied from class: WorkflowPersistorVersion1xx

Sub class hook o read port settings.

Overrides:

loadOutPortsSetting in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadOutPortsSettingsEnum

protected NodeSettingsRO loadOutPortsSettingsEnum(NodeSettingsRO settings)
                                           throws InvalidSettingsException

Sub class hook o read port settings.

Overrides:

loadOutPortsSettingsEnum in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadOutPortTemplate

protected WorkflowPersistor.WorkflowPortTemplate loadOutPortTemplate(NodeSettingsRO settings)
                                                              throws InvalidSettingsException

Sub class hook o read port settings.

Overrides:

loadOutPortTemplate in class WorkflowPersistorVersion1xx

Parameters:

settings - Ignored.

Returns:

null

Throws:

InvalidSettingsException - Not actually thrown here.

loadIfMustWarnOnDataLoadError

protected boolean loadIfMustWarnOnDataLoadError(File workflowDir)

Sub class hook to check whether there is a "loaded with no data" file.

Overrides:

loadIfMustWarnOnDataLoadError in class WorkflowPersistorVersion1xx

Parameters:

workflowDir - Ignored here

Returns:

true

saveUIInfoClassName

protected static void saveUIInfoClassName(NodeSettingsWO settings,
                                          UIInformation info)

saveUIInfoSettings

protected static void saveUIInfoSettings(NodeSettingsWO settings,
                                         UIInformation uiInfo)

createWorkflowPersistorLoad

protected WorkflowPersistorVersion200 createWorkflowPersistorLoad(ReferencedFile wfmFile)

Overrides:

createWorkflowPersistorLoad in class WorkflowPersistorVersion1xx

createSingleNodeContainerPersistorLoad

protected SingleNodeContainerPersistorVersion200 createSingleNodeContainerPersistorLoad(ReferencedFile nodeFile)

Overrides:

createSingleNodeContainerPersistorLoad in class WorkflowPersistorVersion1xx

save

public static String save(WorkflowManager wm,
                          ReferencedFile workflowDirRef,
                          ExecutionMonitor execMon,
                          boolean isSaveData)
                   throws IOException,
                          CanceledExecutionException,
                          LockFailedException

Throws:

IOException

CanceledExecutionException

LockFailedException

saveWorkflowName

protected static void saveWorkflowName(NodeSettingsWO settings,
                                       String name)

saveWorkflowCipher

protected static void saveWorkflowCipher(NodeSettings settings,
                                         WorkflowCipher workflowCipher)

Metanode locking information.

Parameters:

settings -

workflowCipher -

saveTemplateInformation

protected static void saveTemplateInformation(MetaNodeTemplateInformation mnti,
                                              NodeSettingsWO settings)

saveWorkflowVariables

protected static void saveWorkflowVariables(WorkflowManager wfm,
                                            NodeSettingsWO settings)

saveCredentials

protected static void saveCredentials(WorkflowManager wfm,
                                      NodeSettingsWO settings)

saveWorkflowAnnotations

protected static void saveWorkflowAnnotations(WorkflowManager manager,
                                              NodeSettingsWO settings)

saveSettingsForNodes

protected static NodeSettingsWO saveSettingsForNodes(NodeSettingsWO settings)

Save nodes in an own sub-config object as a series of configs.

Parameters:

settings - To save to.

Returns:

The sub config where subsequent writing takes place.

saveSettingsForConnections

protected static NodeSettingsWO saveSettingsForConnections(NodeSettingsWO settings)

Save connections in an own sub-config object.

Parameters:

settings - To save to.

Returns:

The sub config where subsequent writing takes place.

saveNodeContainer

protected static void saveNodeContainer(NodeSettingsWO settings,
                                        ReferencedFile workflowDirRef,
                                        NodeContainer container,
                                        ExecutionMonitor exec,
                                        boolean isSaveData)
                                 throws CanceledExecutionException,
                                        IOException,
                                        LockFailedException

Throws:

CanceledExecutionException

IOException

LockFailedException

saveNodeIDSuffix

protected static void saveNodeIDSuffix(NodeSettingsWO settings,
                                       NodeContainer nc)

saveFileLocation

protected static void saveFileLocation(NodeSettingsWO settings,
                                       String location)

saveIsMeta

protected static void saveIsMeta(NodeSettingsWO settings,
                                 NodeContainer nc)

saveInPortsSetting

protected static NodeSettingsWO saveInPortsSetting(NodeSettingsWO settings)

saveInPortsEnumSetting

protected static NodeSettingsWO saveInPortsEnumSetting(NodeSettingsWO settings)

saveInPortSetting

protected static NodeSettingsWO saveInPortSetting(NodeSettingsWO settings,
                                                  int portIndex)

saveInportsBarUIInfoClassName

protected static void saveInportsBarUIInfoClassName(NodeSettingsWO settings,
                                                    UIInformation info)

saveInportsBarUIInfoSettings

protected static void saveInportsBarUIInfoSettings(NodeSettingsWO settings,
                                                   UIInformation uiInfo)

saveInPort

protected static void saveInPort(NodeSettingsWO settings,
                                 WorkflowManager wm,
                                 int portIndex)

saveOutPortsSetting

protected static NodeSettingsWO saveOutPortsSetting(NodeSettingsWO settings)

saveOutPortsEnumSetting

protected static NodeSettingsWO saveOutPortsEnumSetting(NodeSettingsWO settings)

saveOutportsBarUIInfoClassName

protected static void saveOutportsBarUIInfoClassName(NodeSettingsWO settings,
                                                     UIInformation info)

saveOutportsBarUIInfoSettings

protected static void saveOutportsBarUIInfoSettings(NodeSettingsWO settings,
                                                    UIInformation uiInfo)

saveOutPortSetting

protected static NodeSettingsWO saveOutPortSetting(NodeSettingsWO settings,
                                                   int portIndex)

saveOutPort

protected static void saveOutPort(NodeSettingsWO settings,
                                  WorkflowManager wm,
                                  int portIndex)

saveConnection

protected static void saveConnection(NodeSettingsWO settings,
                                     ConnectionContainer connection)