org.knime.core.node.workflow
Interface NodeOutPort

All Superinterfaces:
NodePort, NodeStateChangeListener
All Known Implementing Classes:
NodeContainerOutPort, NodeOutPortWrapper, WorkflowOutPort

public interface NodeOutPort
extends NodePort, NodeStateChangeListener

Interface for a node's output port. A variable number of input ports can be connected to it (which are part of the next nodes in the workflow).

Author:
Thomas Gabriel, University of Konstanz

Method Summary
 boolean addNodeStateChangeListener(NodeStateChangeListener listener)
           
 void disposePortView()
          Dispose the view (if any) associated with this port.
 FlowObjectStack getFlowObjectStack()
          Returns the FlowObjectStack of the underlying node.
 HiLiteHandler getHiLiteHandler()
          Returns the hilite handler for this port as set by the node this port is output for.
 NodeContainer.State getNodeState()
           
 PortObject getPortObject()
          Returns the DataTable for this port, as set by the node this port is output for.
 PortObjectSpec getPortObjectSpec()
          Returns the DataTableSpec or null if not available.
 String getPortSummary()
          Get summary of the underlying port object as provided by PortObject.getSummary().
 void notifyNodeStateChangeListener(NodeStateEvent e)
           
 void openPortView(String name)
          Opens the port view for this port with the given name.
 boolean removeNodeStateChangeListener(NodeStateChangeListener listener)
           
 
Methods inherited from interface org.knime.core.node.workflow.NodePort
getPortIndex, getPortName, getPortType, setPortName
 
Methods inherited from interface org.knime.core.node.workflow.NodeStateChangeListener
stateChanged
 

Method Detail

getPortObjectSpec

PortObjectSpec getPortObjectSpec()
Returns the DataTableSpec or null if not available.

Returns:
The DataTableSpec for this port.

getPortObject

PortObject getPortObject()
Returns the DataTable for this port, as set by the node this port is output for.

Returns:
PortObject the object for this port. Can be null.

getPortSummary

String getPortSummary()
Get summary of the underlying port object as provided by PortObject.getSummary(). It's a separate method since calling getPortObject().getSummary() may force the underlying table (if it is a table) to restore its content from disc. Summaries are saved in the workflow file (or the node's corresponding sub directory).

Returns:
The port object's summary.

getNodeState

NodeContainer.State getNodeState()
Returns:
the state of the node owning this port.

getHiLiteHandler

HiLiteHandler getHiLiteHandler()
Returns the hilite handler for this port as set by the node this port is output for.

Returns:
The HiLiteHandler for this port or null.

getFlowObjectStack

FlowObjectStack getFlowObjectStack()
Returns the FlowObjectStack of the underlying node.

Returns:
the flow obj stack container

openPortView

void openPortView(String name)
Opens the port view for this port with the given name.

Parameters:
name - The name of the port view.

disposePortView

void disposePortView()
Dispose the view (if any) associated with this port.


addNodeStateChangeListener

boolean addNodeStateChangeListener(NodeStateChangeListener listener)
Parameters:
listener - a listener to the state of the port, that is the state of the predecessor node
Returns:
true if the listener was added, false if it was already registered

removeNodeStateChangeListener

boolean removeNodeStateChangeListener(NodeStateChangeListener listener)
Parameters:
listener - the listener to be de-registered
Returns:
true if it was successfully removed, false if it was not registered

notifyNodeStateChangeListener

void notifyNodeStateChangeListener(NodeStateEvent e)
Parameters:
e - the event which should be forwarded to all regsitered NodeStateChangeListeners


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.