org.knime.core.node.port.inactive
Class InactiveBranchPortObject

java.lang.Object
  org.knime.core.node.port.inactive.InactiveBranchPortObject

All Implemented Interfaces:

PortObject

public final class InactiveBranchPortObject
extends Object
implements PortObject

An empty PortObject implementation which indicates that this node execution was skipped (likely because it is part of inactive IF-ENDIF branch).

Author:

M. Berthold, 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 InactiveBranchPortObject

INSTANCE Singleton to be used.

Method Summary

static PortObject.PortObjectSerializer<InactiveBranchPortObject>	getPortObjectSerializer() Serializer as required by PortObject class.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final InactiveBranchPortObject INSTANCE

Singleton to be used.

Method Detail

getPortObjectSerializer

public static PortObject.PortObjectSerializer<InactiveBranchPortObject> getPortObjectSerializer()

Serializer as required by PortObject class.

Returns:

The serializer.

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).

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.

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