|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.NodeModel
org.knime.base.node.viz.table.TableNodeModel
public class TableNodeModel
Node model for a table view. This class is implemented in first place to
comply with the model-view-controller concept. Thus, this implementation does
not have any further functionality than its super class NodeModel
.
The content itself resides in
TableContentModel
.
TableContentModel
Field Summary | |
---|---|
protected static int |
INPORT
Index of the input port (only one anyway). |
Constructor Summary | |
---|---|
TableNodeModel()
Constructs a new (but empty) model. |
Method Summary | |
---|---|
protected DataTableSpec[] |
configure(DataTableSpec[] inSpecs)
This function is called whenever the derived model should re-configure its output DataTableSpecs. |
protected BufferedDataTable[] |
execute(BufferedDataTable[] data,
ExecutionContext exec)
Called when new data is available. |
TableContentModel |
getContentModel()
Get reference to the underlying content model. |
BufferedDataTable[] |
getInternalTables()
|
protected void |
loadInternals(File internDir,
ExecutionMonitor exec)
Load internals into the derived NodeModel . |
protected void |
loadValidatedSettingsFrom(NodeSettingsRO settings)
Sets new settings from the passed object in the model. |
protected void |
reset()
Override this function in the derived model and reset your NodeModel . |
protected void |
saveInternals(File internDir,
ExecutionMonitor exec)
Save internals of the derived NodeModel . |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Adds to the given NodeSettings the model specific
settings. |
void |
setInternalTables(BufferedDataTable[] tables)
Allows the WorkflowManager to set information about new BDTs, for instance after load. |
protected void |
validateSettings(NodeSettingsRO settings)
Validates the settings in the passed NodeSettings object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final int INPORT
Constructor Detail |
---|
public TableNodeModel()
Method Detail |
---|
public TableContentModel getContentModel()
null
.
protected BufferedDataTable[] execute(BufferedDataTable[] data, ExecutionContext exec)
TableContentModel
and starts
event firing to inform listeners. Do not call this method separately, it
is invoked by this model's node.
execute
in class NodeModel
data
- the data table at the (single) input port, wrapped in a
one-dimensional arrayexec
- the execution monitor
NodeModel.execute(BufferedDataTable[],ExecutionContext)
protected void loadInternals(File internDir, ExecutionMonitor exec) throws IOException
NodeModel
. This method is
only called if the Node
was executed. Read all your
internal structures from the given file directory to create your internal
data structure which is necessary to provide all node functionalities
after the workflow is loaded, e.g. view content and/or hilite mapping.
loadInternals
in class NodeModel
internDir
- The directory to read from.exec
- Used to report progress and to cancel the load process.
IOException
- If an error occurs during reading from this dir.NodeModel.saveInternals(File,ExecutionMonitor)
protected void saveInternals(File internDir, ExecutionMonitor exec) throws IOException
NodeModel
. This method is
only called if the Node
is executed. Write all your
internal structures into the given file directory which are necessary to
recreate this model when the workflow is loaded, e.g. view content and/or
hilite mapping.
saveInternals
in class NodeModel
internDir
- The directory to write into.exec
- Used to report progress and to cancel the save process.
IOException
- If an error occurs during writing to this dir.NodeModel.loadInternals(File,ExecutionMonitor)
public BufferedDataTable[] getInternalTables()
getInternalTables
in interface BufferedDataTableHolder
public void setInternalTables(BufferedDataTable[] tables)
setInternalTables
in interface BufferedDataTableHolder
tables
- the array of new tablesprotected void reset()
NodeModel
. All components should unregister themselves
from any observables (at least from the hilite handler right now). All
internally stored data structures should be released. User settings
should not be deleted/reset though.
reset
in class NodeModel
protected DataTableSpec[] configure(DataTableSpec[] inSpecs)
The passed DataTableSpec elements are never null
but can
be empty. The model may return null
data table spec(s) for
the outputs. But still, the model may be in an executable state. Note,
after the model has been executed this function will not be called
anymore, as the output DataTableSpecs are then being pulled from the
output DataTables. A derived NodeModel
that cannot provide
any DataTableSpecs at its outputs before execution (because the table
structure is unknown at this point) can return an array
containing just null
elements.
Implementation note: This method is called from the
NodeModel.configure(PortObjectSpec[])
method unless that method is
overwritten.
configure
in class NodeModel
inSpecs
- An array of DataTableSpecs (as many as this model has
inputs). Do NOT modify the contents of this array. None of the
DataTableSpecs in the array can be null
but
empty. If the predecessor node is not yet connected, or
doesn't provide a DataTableSpecs at its output port.
null
DataTableSpec elements are changed to empty
once.protected void loadValidatedSettingsFrom(NodeSettingsRO settings) throws InvalidSettingsException
#validateSettings(NodeSettings)
method. The model must set
its internal configuration according to the settings object passed.
loadValidatedSettingsFrom
in class NodeModel
settings
- The settings to read.
InvalidSettingsException
- If a property is not available.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void saveSettingsTo(NodeSettingsWO settings)
NodeSettings
the model specific
settings. The settings don't need to be complete or consistent. If, right
after startup, no valid settings are available this method can write
either nothing or invalid settings.
Method is called by the Node
if the current settings need
to be saved or transfered to the node's dialog.
saveSettingsTo
in class NodeModel
settings
- The object to write settings into.NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void validateSettings(NodeSettingsRO settings) throws InvalidSettingsException
NodeSettings
object.
The specified settings should be checked for completeness and
consistency. It must be possible to load a settings object validated
here without any exception in the
#loadValidatedSettings(NodeSettings)
method. The method
must not change the current settings in the model - it is supposed to
just check them. If some settings are missing, invalid, inconsistent, or
just not right throw an exception with a message useful to the user.
validateSettings
in class NodeModel
settings
- The settings to validate.
InvalidSettingsException
- If the validation of the settings
failed.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |