|
||||||||||
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
public abstract class AbstractHistogramNodeModel
Field Summary | |
---|---|
static String |
CFG_DATA_DIR_NAME
The name of the directory which holds the optional data of the different histogram implementations. |
protected static String |
CFGKEY_AGGR_COLNAME
Settings name of the aggregation column name. |
protected static String |
CFGKEY_ALL_ROWS
Settings name for the take all rows select box. |
protected static String |
CFGKEY_NO_OF_ROWS
Settings name of the number of rows. |
protected static String |
CFGKEY_X_COLNAME
Used to store the attribute column name in the settings. |
protected static int |
DEFAULT_NO_OF_ROWS
Default number of rows to use. |
Constructor Summary | |
---|---|
AbstractHistogramNodeModel()
Constructor for class AbstractHistogramNodeModel. |
Method Summary | |
---|---|
protected DataTableSpec[] |
configure(PortObjectSpec[] inSpecs)
Configure method for general port types. |
protected abstract void |
createHistogramModel(ExecutionContext exec,
int noOfRows,
BufferedDataTable table)
This method should use the given information to create the internal histogram data model. |
protected PortObject[] |
execute(PortObject[] inData,
ExecutionContext exec)
Execute method for general port types. |
protected Collection<ColorColumn> |
getAggrColumns()
|
protected abstract AbstractHistogramVizModel |
getHistogramVizModel()
This method creates a new AbstractHistogramVizModel each time
it is called. |
protected String |
getSelectedXColumnName()
|
protected DataTableSpec |
getTableSpec()
|
protected int |
getXColIdx()
|
protected DataColumnSpec |
getXColSpec()
|
protected abstract void |
loadHistogramInternals(File dataDir,
ExecutionMonitor exec)
Called from the loadInternals(File, ExecutionMonitor) method
to let the histogram implementation load own internal data. |
protected void |
loadInternals(File nodeInternDir,
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 abstract void |
saveHistogramInternals(File dataDir,
ExecutionMonitor exec)
Called from the saveInternals(File, ExecutionMonitor) method
to let the histogram implementation save own internal data. |
protected void |
saveInternals(File nodeInternDir,
ExecutionMonitor exec)
Save internals of the derived NodeModel . |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Adds to the given NodeSettings the model specific
settings. |
protected void |
setAllRowsDefault(boolean allRows)
|
protected void |
setSelectedAggrColumns(ColorColumn... aggrCols)
|
protected void |
setSelectedXColumnName(String name)
|
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 DEFAULT_NO_OF_ROWS
protected static final String CFGKEY_ALL_ROWS
protected static final String CFGKEY_NO_OF_ROWS
protected static final String CFGKEY_X_COLNAME
protected static final String CFGKEY_AGGR_COLNAME
public static final String CFG_DATA_DIR_NAME
Constructor Detail |
---|
public AbstractHistogramNodeModel()
Method Detail |
---|
protected void setAllRowsDefault(boolean allRows)
allRows
- set the default value of the all rows select box.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)
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 loadInternals(File nodeInternDir, 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
nodeInternDir
- 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 abstract void loadHistogramInternals(File dataDir, ExecutionMonitor exec) throws Exception
loadInternals(File, ExecutionMonitor)
method
to let the histogram implementation load own internal data.
dataDir
- the directory to write toexec
- the ExecutionMonitor
to provide progress message
Exception
- if an exception occursprotected void saveInternals(File nodeInternDir, ExecutionMonitor exec)
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
nodeInternDir
- The directory to write into.exec
- Used to report progress and to cancel the save process.NodeModel.loadInternals(File,ExecutionMonitor)
protected abstract void saveHistogramInternals(File dataDir, ExecutionMonitor exec) throws Exception
saveInternals(File, ExecutionMonitor)
method
to let the histogram implementation save own internal data.
dataDir
- the directory to write toexec
- the ExecutionMonitor
to provide progress message
Exception
- if an exception occursprotected 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 abstract AbstractHistogramVizModel getHistogramVizModel()
AbstractHistogramVizModel
each time
it is called.
null
if not
all information are available yetprotected 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 NodeModel
inSpecs
- The input object specs.
InvalidSettingsException
- If this node can't be configured.protected PortObject[] execute(PortObject[] inData, ExecutionContext exec) throws Exception
PortObject classes
that are defined through the
PortTypes
given in the
constructor
.
Similarly, the returned output objects need to comply with their port
types object class (otherwise an error is reported by the framework).
For a general description of the execute method refer to the description
of the specialized
NodeModel.execute(BufferedDataTable[], ExecutionContext)
methods as it
addresses more use cases.
execute
in class NodeModel
inData
- The input objects.exec
- For BufferedDataTable
creation and progress.
Exception
- If the node execution fails for any reason.protected abstract void createHistogramModel(ExecutionContext exec, int noOfRows, BufferedDataTable table) throws CanceledExecutionException
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 getTableSpec()
DataTableSpec
of the input tableprotected Collection<ColorColumn> getAggrColumns()
null
if
the user hasn't selected a aggregation columnprotected String getSelectedXColumnName()
protected void setSelectedXColumnName(String name)
name
- the new selected x column nameprotected void setSelectedAggrColumns(ColorColumn... aggrCols)
aggrCols
- the new selected aggregation columnprotected DataColumnSpec getXColSpec()
DataColumnSpec
of the selected x columnprotected int getXColIdx()
DataTableSpec
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |