org.knime.core.node.workflow
Class NodeContainerMetaPersistorVersion200

java.lang.Object
  extended by org.knime.core.node.workflow.NodeContainerMetaPersistorVersion1xx
      extended by org.knime.core.node.workflow.NodeContainerMetaPersistorVersion200
All Implemented Interfaces:
NodeContainerMetaPersistor

 class NodeContainerMetaPersistorVersion200
extends NodeContainerMetaPersistorVersion1xx

Author:
wiswedel, University of Konstanz

Field Summary
 
Fields inherited from interface org.knime.core.node.workflow.NodeContainerMetaPersistor
KEY_CUSTOM_DESCRIPTION, KEY_CUSTOM_NAME
 
Constructor Summary
NodeContainerMetaPersistorVersion200(ReferencedFile baseDir)
           
 
Method Summary
protected  String loadCustomDescription(NodeSettingsRO settings, NodeSettingsRO parentSettings)
          Read the custom description.
protected  String loadCustomName(NodeSettingsRO settings, NodeSettingsRO parentSettings)
          Read the custom name.
protected  boolean loadIsDeletable(NodeSettingsRO settings)
          
protected  ReferencedFile loadJobManagerInternalsDirectory(ReferencedFile parentDir, NodeSettingsRO settings)
          Load the directory name that is used to persist internals of the associated job manager.
protected  NodeExecutionJobManager loadNodeExecutionJobManager(NodeSettingsRO settings)
          Load the execution manager responsible for this node.
protected  NodeSettingsRO loadNodeExecutionJobSettings(NodeSettingsRO settings)
          Load the settings representing the pending execution of this node.
protected  NodeMessage loadNodeMessage(NodeSettingsRO settings)
          
protected  NodeContainer.State loadState(NodeSettingsRO settings, NodeSettingsRO parentSettings)
          Load the state of the node.
 void save(NodeContainer nc, NodeSettingsWO settings)
           
protected  void saveCustomDescription(NodeSettingsWO settings, NodeContainer nc)
           
protected  void saveCustomName(NodeSettingsWO settings, NodeContainer nc)
           
protected  void saveIsDeletable(NodeSettingsWO settings, NodeContainer nc)
           
protected  void saveJobManagerInternalsDirectory(NodeSettingsWO settings, NodeContainer nc)
           
protected  void saveNodeExecutionJob(NodeSettingsWO settings, NodeContainer nc)
           
protected  void saveNodeExecutionJobManager(NodeSettingsWO settings, NodeContainer nc)
           
protected  void saveNodeMessage(NodeSettingsWO settings, NodeContainer nc)
           
protected  boolean saveState(NodeSettingsWO settings, NodeContainer nc)
           
 
Methods inherited from class org.knime.core.node.workflow.NodeContainerMetaPersistorVersion1xx
getCustomDescription, getCustomName, getExecutionJobManager, getExecutionJobSettings, getLogger, getNodeContainerDirectory, getNodeIDSuffix, getNodeMessage, getState, getUIInfo, isDeletable, isDirtyAfterLoad, load, setDirtyAfterLoad, setNodeIDSuffix, setUIInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeContainerMetaPersistorVersion200

NodeContainerMetaPersistorVersion200(ReferencedFile baseDir)
Parameters:
baseDir - The node container directory (only important while load)
Method Detail

loadNodeExecutionJobManager

protected NodeExecutionJobManager loadNodeExecutionJobManager(NodeSettingsRO settings)
                                                       throws InvalidSettingsException
Load the execution manager responsible for this node. This methods is overwritten in the persistor reading the 2.0+ workflows.

Overrides:
loadNodeExecutionJobManager in class NodeContainerMetaPersistorVersion1xx
Parameters:
settings - To load from.
Returns:
null (only this implementation).
Throws:
InvalidSettingsException - If that fails.

loadNodeExecutionJobSettings

protected NodeSettingsRO loadNodeExecutionJobSettings(NodeSettingsRO settings)
                                               throws InvalidSettingsException
Load the settings representing the pending execution of this node. Returns null if this node was not saved as being executing.

Overrides:
loadNodeExecutionJobSettings in class NodeContainerMetaPersistorVersion1xx
Parameters:
settings - To load from.
Returns:
The execution job.
Throws:
InvalidSettingsException - If that fails.

loadJobManagerInternalsDirectory

protected ReferencedFile loadJobManagerInternalsDirectory(ReferencedFile parentDir,
                                                          NodeSettingsRO settings)
                                                   throws InvalidSettingsException
Load the directory name that is used to persist internals of the associated job manager. The default (local) job manager typically does not save any internals, but others (e.g. the grid executor) save the logs of their remote jobs.

Overrides:
loadJobManagerInternalsDirectory in class NodeContainerMetaPersistorVersion1xx
Parameters:
parentDir - The parent directory (the node dir).
settings - To load from.
Returns:
The file location containing the internals or null.
Throws:
InvalidSettingsException - If errors occur.

loadState

protected NodeContainer.State loadState(NodeSettingsRO settings,
                                        NodeSettingsRO parentSettings)
                                 throws InvalidSettingsException
Load the state of the node.

Overrides:
loadState in class NodeContainerMetaPersistorVersion1xx
Parameters:
settings - The settings associated with the node (used in 2.0+)
parentSettings - The parent settings (workflow.knime, used in 1.3x)
Returns:
The state
Throws:
InvalidSettingsException - In case of errors reading the argument

loadIsDeletable

protected boolean loadIsDeletable(NodeSettingsRO settings)

Overrides:
loadIsDeletable in class NodeContainerMetaPersistorVersion1xx

loadCustomName

protected String loadCustomName(NodeSettingsRO settings,
                                NodeSettingsRO parentSettings)
                         throws InvalidSettingsException
Read the custom name.

Overrides:
loadCustomName in class NodeContainerMetaPersistorVersion1xx
Parameters:
settings - The settings associated with the node (used in 2.0+)
parentSettings - The parent settings (workflow.knime, used in 1.3x)
Returns:
The custom name or null
Throws:
InvalidSettingsException - In case of errors reading the argument

loadCustomDescription

protected String loadCustomDescription(NodeSettingsRO settings,
                                       NodeSettingsRO parentSettings)
                                throws InvalidSettingsException
Read the custom description.

Overrides:
loadCustomDescription in class NodeContainerMetaPersistorVersion1xx
Parameters:
settings - The settings associated with the node (used in 2.0+)
parentSettings - The parent settings (workflow.knime, used in 1.3x)
Returns:
The custom name or null
Throws:
InvalidSettingsException - In case of errors reading the argument

loadNodeMessage

protected NodeMessage loadNodeMessage(NodeSettingsRO settings)
                               throws InvalidSettingsException

Overrides:
loadNodeMessage in class NodeContainerMetaPersistorVersion1xx
Throws:
InvalidSettingsException

save

public void save(NodeContainer nc,
                 NodeSettingsWO settings)
          throws IOException
Throws:
IOException

saveNodeExecutionJobManager

protected void saveNodeExecutionJobManager(NodeSettingsWO settings,
                                           NodeContainer nc)

saveNodeExecutionJob

protected void saveNodeExecutionJob(NodeSettingsWO settings,
                                    NodeContainer nc)

saveJobManagerInternalsDirectory

protected void saveJobManagerInternalsDirectory(NodeSettingsWO settings,
                                                NodeContainer nc)

saveState

protected boolean saveState(NodeSettingsWO settings,
                            NodeContainer nc)

saveCustomName

protected void saveCustomName(NodeSettingsWO settings,
                              NodeContainer nc)

saveCustomDescription

protected void saveCustomDescription(NodeSettingsWO settings,
                                     NodeContainer nc)

saveIsDeletable

protected void saveIsDeletable(NodeSettingsWO settings,
                               NodeContainer nc)

saveNodeMessage

protected void saveNodeMessage(NodeSettingsWO settings,
                               NodeContainer nc)


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.