org.knime.core.node.port.flowvariable
Class FlowVariablePortObject

java.lang.Object
  org.knime.core.node.port.flowvariable.FlowVariablePortObject

All Implemented Interfaces:

PortObject

public class FlowVariablePortObject
extends Object
implements PortObject

A singleton port object representing a variable input. Flow Variables ports and their connections carry no data, nor variables but just represent a connection. Variables are propagated through the workflow using framework methods, each node can read and write variables using methods in the NodeModel (as opposed to have these methods defined on the port object).

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>

Field Summary

static FlowVariablePortObject	INSTANCE Singleton instance to be used.
static PortType	TYPE Type representing this port object.
static PortType	TYPE_OPTIONAL Type representing this port object as optional.

Constructor Summary

FlowVariablePortObject()
Deprecated. There is only one instance to this class. Future versions of KNIME will reduce the scope of this constructor and declare this class final.

Method Summary

boolean	equals(Object obj)
static PortObject.PortObjectSerializer<FlowVariablePortObject>	getPortObjectSerializer() Serializer for this port object.
PortObjectSpec	getSpec() Get specification to this port object.
String	getSummary() Get a short summary of this PortObject.
JComponent[]	getViews() The returned views are displayed in the out port view of the referring node.
int	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

Type representing this port object.

TYPE_OPTIONAL

public static final PortType TYPE_OPTIONAL

Type representing this port object as optional.

INSTANCE

public static final FlowVariablePortObject INSTANCE

Singleton instance to be used.

Constructor Detail

FlowVariablePortObject

@Deprecated
public FlowVariablePortObject()

Deprecated. There is only one instance to this class. Future versions of KNIME will reduce the scope of this constructor and declare this class final.

Constructor, not to be used.

Method Detail

getPortObjectSerializer

public static PortObject.PortObjectSerializer<FlowVariablePortObject> getPortObjectSerializer()

Serializer for this port object. It will return the singleton upon read.

Returns:

The serializer as required by the PortObject class.

getSpec

public PortObjectSpec 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.

Specified by:

getSpec in interface PortObject

Returns:

underlying PortObjectSpec or any derived spec, never null.

getSummary

public String getSummary()

Get a short summary of this PortObject. The return value will be shown in a node port's tooltip, for instance.

Specified by:

getSummary in interface PortObject

Returns:

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

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

Returns:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object