org.knime.core.node.port
Interface PortObjectSpec

All Known Implementing Classes:

AbstractSimplePortObjectSpec, BWElimModel, DatabasePortObjectSpec, DataTableSpec, FlowVariablePortObjectSpec, ImagePortObjectSpec, InactiveBranchPortObjectSpec, NaiveBayesPortObjectSpec, PCAModelPortObjectSpec, PMCCPortObjectAndSpec, PMMLDiscretizePreprocPortObjectSpec, PMMLPortObjectSpec, PMMLPreprocPortObjectSpec, SotaPortObjectSpec

public interface PortObjectSpec

General interface for object specifications that are passed along node connections. Most prominent example of such a class is DataTableSpec, which is used to represent table specification. PortObjectSpec objects represent the information that is necessary during a node's configuration step. They are assumed to be fairly small objects (usually reside in memory) and describe the general structure of PortObject objects (which are passed along the connections during a node's execution). Both the class of a PortObjectSpec and a PortObject describe PortType.

Important: Implementors of this interface must also provide a PortObjectSpec.PortObjectSpecSerializer, which is used to save and load instances. The framework will try to invoke a static method defined in the implementation with the following signature:

  public static PortObjectSpecSerializer<FooPortObjectSpec> 
          getPortObjectSpecSerializer(final File directory) 
              throws IOException {...}
 

If the class does not have such a static method (or it has the wrong signature), an exception will be thrown at runtime.

Note: The API of this class is not finalized and may slightly change in future versions.

Since:

2.0

Author:

M. Berthold & B. Wiswedel, University of Konstanz

See Also:

DataTableSpec, PortObject, PortType

Nested Class Summary

static class

PortObjectSpec.PortObjectSpecSerializer<T extends PortObjectSpec> Factory class that's used for writing and loading objects of class denoted by T.

Method Summary

JComponent[]

getViews() The returned views are displayed in the out port view of the referring node.

Method Detail

getViews

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.

Returns:

an array of views for the port object spec, each displayed as a tab in the out port view