org.knime.core.node.port.viewproperty
Class SizeHandlerPortObject

java.lang.Object
  extended by org.knime.core.node.port.AbstractSimplePortObject
      extended by org.knime.core.node.port.viewproperty.ViewPropertyPortObject
          extended by org.knime.core.node.port.viewproperty.SizeHandlerPortObject
All Implemented Interfaces:
PortObject

public class SizeHandlerPortObject
extends ViewPropertyPortObject

PortObject implementation for SizeHandlerPortObject which are part of a DataTableSpec.

Author:
Thomas Gabriel, University of Konstanz

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.knime.core.node.port.PortObject
PortObject.PortObjectSerializer<T extends PortObject>
 
Field Summary
static PortType TYPE
          Convenience access method for port type.
 
Constructor Summary
SizeHandlerPortObject()
          Public no arg constructor required by super class.
SizeHandlerPortObject(DataTableSpec spec, String portSummary)
          Constructor used to instantiate this object during a node's execute method.
 
Method Summary
 JComponent[] getViews()
          The returned views are displayed in the out port view of the referring node.
 
Methods inherited from class org.knime.core.node.port.viewproperty.ViewPropertyPortObject
getSpec, getSummary, load, save
 
Methods inherited from class org.knime.core.node.port.AbstractSimplePortObject
equals, getPortObjectSerializer, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static final PortType TYPE
Convenience access method for port type.

Constructor Detail

SizeHandlerPortObject

public SizeHandlerPortObject()
Public no arg constructor required by super class.

This constructor should only be used by the framework.


SizeHandlerPortObject

public SizeHandlerPortObject(DataTableSpec spec,
                             String portSummary)
Constructor used to instantiate this object during a node's execute method.

Parameters:
spec - The accompanying spec
portSummary - A summary returned in the ViewPropertyPortObject.getSummary() method.
Throws:
NullPointerException - If spec argument is null.
Method Detail

getViews

public JComponent[] getViews()
The returned views are displayed in the out port view of the referring node. Each component is displayed in an extra tab. The name of the component is used as the title for the tab. It is important that no external members are kept in the component so it can be deleted, when the port object is deleted. If the port object has no view return an empty array.

Specified by:
getViews in interface PortObject
Overrides:
getViews in class AbstractSimplePortObject
Returns:
an array of views for the port object, each displayed as a tab in the out port view


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.