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

java.lang.Object
  extended by org.knime.core.node.port.AbstractSimplePortObject
      extended by org.knime.core.node.port.viewproperty.ViewPropertyPortObject
All Implemented Interfaces:
PortObject
Direct Known Subclasses:
ColorHandlerPortObject, ShapeHandlerPortObject, SizeHandlerPortObject

public abstract class ViewPropertyPortObject
extends AbstractSimplePortObject

PortObject used to represent visual properties such as color, shape and size information attached to a table. The content of this object resides in the accompanying DataTableSpec.

Author:
Bernd Wiswedel, University of Konstanz

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.knime.core.node.port.PortObject
PortObject.PortObjectSerializer<T extends PortObject>
 
Constructor Summary
protected ViewPropertyPortObject()
          Public no arg constructor required by super class.
protected ViewPropertyPortObject(DataTableSpec spec, String portSummary)
          Constructor used to instantiate this object during a node's execute method.
 
Method Summary
 DataTableSpec getSpec()
          Get specification to this port object.
 String getSummary()
          Get a short summary of this PortObject.
protected  void load(ModelContentRO model, PortObjectSpec spec, ExecutionMonitor exec)
          Loads the content into the freshly instantiated object.
protected  void save(ModelContentWO model, ExecutionMonitor exec)
          Saves this object to model content object.
 
Methods inherited from class org.knime.core.node.port.AbstractSimplePortObject
equals, getPortObjectSerializer, getViews, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewPropertyPortObject

protected ViewPropertyPortObject()
Public no arg constructor required by super class.

This constructor should only be used by the framework.


ViewPropertyPortObject

protected ViewPropertyPortObject(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 getSummary() method.
Throws:
NullPointerException - If spec argument is null.
Method Detail

load

protected void load(ModelContentRO model,
                    PortObjectSpec spec,
                    ExecutionMonitor exec)
             throws InvalidSettingsException,
                    CanceledExecutionException
Loads the content into the freshly instantiated object. This method is called at most once in the life time of the object (after the serializer has created a new object using the public no-arg constructor.)

Specified by:
load in class AbstractSimplePortObject
Parameters:
model - To load from.
spec - The accompanying spec (which can be safely cast to the expected class).
exec - For progress/cancelation.
Throws:
InvalidSettingsException - If settings are incomplete/deficient.
CanceledExecutionException - If canceled.

save

protected void save(ModelContentWO model,
                    ExecutionMonitor exec)
             throws CanceledExecutionException
Saves this object to model content object.

Specified by:
save in class AbstractSimplePortObject
Parameters:
model - To save to.
exec - For progress/cancelation.
Throws:
CanceledExecutionException - If canceled.

getSpec

public final DataTableSpec getSpec()
Get specification to this port object. That is, the corresponding PortObjectSpec which is used to configure any successor node after execution, e.g. a BufferedDataTable can return a DataTableSpec.

Subclasses should narrow the return type if possible.

Returns:
underlying PortObjectSpec or any derived spec, never null.

getSummary

public final String getSummary()
Get a short summary of this PortObject. The return value will be shown in a node port's tooltip, for instance.

Returns:
Summary of the object's content, suitable for a tooltip. Empty strings and null result values are ok (though not encouraged).


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.