|
||||||||||
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.histogram.node.AbstractHistogramNodeModel
org.knime.base.node.viz.histogram.node.FixedColumnHistogramNodeModel
public class FixedColumnHistogramNodeModel
The NodeModel class of the histogram plotter.
Field Summary | |
---|---|
protected static String |
CFGKEY_NO_OF_BINS
The number of bins configuration key. |
Fields inherited from class org.knime.base.node.viz.histogram.node.AbstractHistogramNodeModel |
---|
CFG_DATA_DIR_NAME, CFGKEY_AGGR_COLNAME, CFGKEY_ALL_ROWS, CFGKEY_NO_OF_ROWS, CFGKEY_X_COLNAME, DEFAULT_NO_OF_ROWS |
Constructor Summary | |
---|---|
protected |
FixedColumnHistogramNodeModel()
The constructor. |
Method Summary | |
---|---|
protected DataTableSpec[] |
configure(PortObjectSpec[] inSpecs)
Configure method for general port types. |
protected void |
createHistogramModel(ExecutionContext exec,
int noOfRows,
BufferedDataTable table)
This method should use the given information to create the internal histogram data model. |
protected AbstractHistogramVizModel |
getHistogramVizModel()
This method creates a new AbstractHistogramVizModel each time
it is called. |
protected void |
loadHistogramInternals(File dataDir,
ExecutionMonitor exec)
Called from the AbstractHistogramNodeModel.loadInternals(File, ExecutionMonitor) method
to let the histogram implementation load own internal data. |
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 |
saveHistogramInternals(File dataDir,
ExecutionMonitor exec)
Called from the AbstractHistogramNodeModel.saveInternals(File, ExecutionMonitor) method
to let the histogram implementation save own internal data. |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Adds to the given NodeSettings the model specific
settings. |
protected void |
validateSettings(NodeSettingsRO settings)
Validates the settings in the passed NodeSettings object. |
Methods inherited from class org.knime.base.node.viz.histogram.node.AbstractHistogramNodeModel |
---|
execute, getAggrColumns, getSelectedXColumnName, getTableSpec, getXColIdx, getXColSpec, loadInternals, saveInternals, setAllRowsDefault, setSelectedAggrColumns, setSelectedXColumnName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String CFGKEY_NO_OF_BINS
Constructor Detail |
---|
protected FixedColumnHistogramNodeModel()
Method Detail |
---|
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 AbstractHistogramNodeModel
settings
- The settings to validate.
InvalidSettingsException
- If the validation of the settings
failed.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
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 AbstractHistogramNodeModel
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 AbstractHistogramNodeModel
settings
- The object to write settings into.NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void createHistogramModel(ExecutionContext exec, int noOfRows, BufferedDataTable table) throws CanceledExecutionException
createHistogramModel
in class AbstractHistogramNodeModel
exec
- the ExecutionContext
for progress informationnoOfRows
- the number of rows to displaytable
- the DataTable
which contains the rows
CanceledExecutionException
- if the user has canceled the
node executionprotected DataTableSpec[] configure(PortObjectSpec[] inSpecs) throws InvalidSettingsException
PortObjectSpecs
that are defined through the
PortTypes
given in the
constructor
.
Similarly, the returned output specs need to comply with their port types
spec class (otherwise an error is reported by the framework). They may
also be null.
For a general description of the configure method refer to the
description of the specialized NodeModel.configure(DataTableSpec[])
methods as it addresses more use cases.
configure
in class AbstractHistogramNodeModel
inSpecs
- The input object specs.
InvalidSettingsException
- If this node can't be configured.protected 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 AbstractHistogramNodeModel
protected AbstractHistogramVizModel getHistogramVizModel()
AbstractHistogramVizModel
each time
it is called.
getHistogramVizModel
in class AbstractHistogramNodeModel
null
if not
all information are available yetprotected void loadHistogramInternals(File dataDir, ExecutionMonitor exec) throws Exception
AbstractHistogramNodeModel.loadInternals(File, ExecutionMonitor)
method
to let the histogram implementation load own internal data.
loadHistogramInternals
in class AbstractHistogramNodeModel
dataDir
- the directory to write toexec
- the ExecutionMonitor
to provide progress message
Exception
- if an exception occursprotected void saveHistogramInternals(File dataDir, ExecutionMonitor exec) throws Exception
AbstractHistogramNodeModel.saveInternals(File, ExecutionMonitor)
method
to let the histogram implementation save own internal data.
saveHistogramInternals
in class AbstractHistogramNodeModel
dataDir
- the directory to write toexec
- the ExecutionMonitor
to provide progress message
Exception
- if an exception occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |