|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortObject
General interface for objects that are passed along node
connections. Most prominent example of such an object is
BufferedDataTable
.
PortObjects
contain the actual data or models, which are used
during a node's
execution
.
Important: Implementors of this interface must also provide a
PortObject.PortObjectSerializer
, 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 PortObjectSerializer<FooPortObject> getPortObjectSerializer();If the class does not have such a static method (or it has the wrong signature), an exception will be thrown at runtime. There are two exceptions to this rule: Objects of class
BufferedDataTable
and
ModelContent
are treated separately. As such, they do not define
this method (or their implementations throw an exception as the method is
not called by the framework). However, if you do not extend either of these
two classes, you do need to implement the method mentioned above.
Note: The API of this class is not finalized and may slightly change in future versions.
BufferedDataTable
,
PortObjectSpec
,
PortType
,
AbstractPortObject
,
AbstractSimplePortObject
Nested Class Summary | |
---|---|
static class |
PortObject.PortObjectSerializer<T extends PortObject>
Factory class that's used for writing and loading objects of class denoted by T . |
Method Summary | |
---|---|
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. |
Method Detail |
---|
String getSummary()
PortObject
.
The return value will be shown in a node port's tooltip, for instance.
PortObjectSpec getSpec()
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.
PortObjectSpec
or any derived spec,
never null
.JComponent[] getViews()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |