org.knime.core.node.workflow.execresult
Class NodeContainerExecutionResult

java.lang.Object
  extended by org.knime.core.node.workflow.execresult.NodeContainerExecutionResult
All Implemented Interfaces:
NodeContainerExecutionStatus
Direct Known Subclasses:
SingleNodeContainerExecutionResult, WorkflowExecutionResult

public abstract class NodeContainerExecutionResult
extends Object
implements NodeContainerExecutionStatus

Remote execution result. Derived classes define specialized access methods for SingleNodeContainer and WorkflowManager.

Author:
Bernd Wiswedel, University of Konstanz

Field Summary
 
Fields inherited from interface org.knime.core.node.workflow.execresult.NodeContainerExecutionStatus
FAILURE, SUCCESS
 
Constructor Summary
NodeContainerExecutionResult()
           
 
Method Summary
protected  NodeLogger getLogger()
           
 NodeMessage getNodeMessage()
          Get a node message that was set during execution.
 boolean isSuccess()
          Whether the execution was successful.
 boolean needsResetAfterLoad()
           
 void setMessage(NodeMessage message)
          Set a node message.
 void setNeedsResetAfterLoad()
          Request a reset of the node after loading the result.
 void setSuccess(boolean isSuccess)
           
 String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.knime.core.node.workflow.execresult.NodeContainerExecutionStatus
getChildStatus
 

Constructor Detail

NodeContainerExecutionResult

public NodeContainerExecutionResult()
Method Detail

getNodeMessage

public NodeMessage getNodeMessage()
Get a node message that was set during execution.

Returns:
The node message.

setMessage

public void setMessage(NodeMessage message)
Set a node message.

Parameters:
message - the message to set

setNeedsResetAfterLoad

public void setNeedsResetAfterLoad()
Request a reset of the node after loading the result. The node is allowed to trigger a reset if the loading process causes errors that invalidate the computed result.


needsResetAfterLoad

public boolean needsResetAfterLoad()
Returns:
true when the node needs to be reset after loading the results.
See Also:
setNeedsResetAfterLoad()

setSuccess

public void setSuccess(boolean isSuccess)
Parameters:
isSuccess - the isSuccess to set

isSuccess

public boolean isSuccess()
Whether the execution was successful. If the node represents a SingleNodeContainer, a successful execution brings the node into the NodeContainer.State.EXECUTED state, otherwise into NodeContainer.State.IDLE. If this object represents an execution status of a meta node, this method is typically ignored and the state is determined based on the internals of the meta node.

Specified by:
isSuccess in interface NodeContainerExecutionStatus
Returns:
the success status.

getLogger

protected NodeLogger getLogger()
Returns:
the logger (never null).

toString

public String toString()

Overrides:
toString in class Object


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.