|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.port.AbstractSimplePortObject
org.knime.core.node.port.viewproperty.ViewPropertyPortObject
public abstract class ViewPropertyPortObject
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
.
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 |
---|
protected ViewPropertyPortObject()
This constructor should only be used by the framework.
protected ViewPropertyPortObject(DataTableSpec spec, String portSummary)
spec
- The accompanying specportSummary
- A summary returned in the getSummary()
method.
NullPointerException
- If spec argument is null
.Method Detail |
---|
protected void load(ModelContentRO model, PortObjectSpec spec, ExecutionMonitor exec) throws InvalidSettingsException, CanceledExecutionException
load
in class AbstractSimplePortObject
model
- To load from.spec
- The accompanying spec (which can be safely cast to the
expected class).exec
- For progress/cancelation.
InvalidSettingsException
- If settings are incomplete/deficient.
CanceledExecutionException
- If canceled.protected void save(ModelContentWO model, ExecutionMonitor exec) throws CanceledExecutionException
save
in class AbstractSimplePortObject
model
- To save to.exec
- For progress/cancelation.
CanceledExecutionException
- If canceled.public final DataTableSpec 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
.public final String getSummary()
PortObject
.
The return value will be shown in a node port's tooltip, for instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |