|
||||||||||
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.pie.node.PieNodeModel<D>
D
- the PieVizModel
implementationpublic abstract class PieNodeModel<D extends PieVizModel>
The abstract pie chart implementation of theNodeModel
class.
Field Summary | |
---|---|
static ColumnFilter |
AGGREGATION_COLUMN_FILTER
This column filter should be used in all x column select boxes. |
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_AGGR_METHOD
Settings name of the aggregation method. |
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_PIE_COLNAME
Used to store the attribute column name in the settings. |
protected static int |
DEFAULT_NO_OF_ROWS
Default number of rows to use. |
static ColumnFilter |
PIE_COLUMN_FILTER
This column filter should be used in all x column select boxes. |
Constructor Summary | |
---|---|
PieNodeModel()
Constructor for class PieNodeModel. |
Method Summary | |
---|---|
protected DataTableSpec[] |
configure(PortObjectSpec[] inSpecs)
Configure method for general port types. |
protected abstract void |
createModel(ExecutionContext exec,
DataColumnSpec pieColSpec,
DataColumnSpec aggrColSpec,
BufferedDataTable dataTable,
int noOfRows,
boolean containsColorHandler)
Called prior #addDataRow(...) method to allow the
implementing class the specific model creation. |
protected BufferedDataTable[] |
execute(PortObject[] inData,
ExecutionContext exec)
Execute method for general port types. |
protected String |
getAggregationColumnName()
|
protected String |
getPieColumnName()
|
D |
getVizModel()
|
protected abstract D |
getVizModelInternal()
|
protected void |
loadInternals(File nodeInternDir,
ExecutionMonitor exec)
Load internals into the derived NodeModel . |
protected abstract void |
loadPieInternals(File dataDir,
ExecutionMonitor exec)
Loads the implementation internals. |
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 |
resetPieData()
Resets the implementation internal data. |
protected void |
saveInternals(File nodeInternDir,
ExecutionMonitor exec)
Save internals of the derived NodeModel . |
protected abstract void |
savePieInternals(File dataDir,
ExecutionMonitor exec)
Saves the implementation internal data. |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Adds to the given NodeSettings the model specific
settings. |
protected void |
setAggregationColumnName(String name)
|
protected void |
setPieColumnName(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 |
---|
public static final String CFG_DATA_DIR_NAME
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_PIE_COLNAME
protected static final String CFGKEY_AGGR_METHOD
protected static final String CFGKEY_AGGR_COLNAME
public static final ColumnFilter PIE_COLUMN_FILTER
public static final ColumnFilter AGGREGATION_COLUMN_FILTER
Constructor Detail |
---|
public PieNodeModel()
Method Detail |
---|
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)
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 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 BufferedDataTable[] 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 createModel(ExecutionContext exec, DataColumnSpec pieColSpec, DataColumnSpec aggrColSpec, BufferedDataTable dataTable, int noOfRows, boolean containsColorHandler) throws CanceledExecutionException, TooManySectionsException
#addDataRow(...)
method to allow the
implementing class the specific model creation.
exec
- the ExecutionMonitor
pieColSpec
- the DataColumnSpec
of the selected pie columnaggrColSpec
- the DataColumnSpec
of the selected
aggregation columndataTable
- the DataTableSpec
noOfRows
- the expected number of rowscontainsColorHandler
- true
if a color handler is set
CanceledExecutionException
- if the progress was canceled
TooManySectionsException
- if more sections are created than
supportedpublic D getVizModel()
PieVizModel
. Could be null.protected void setPieColumnName(String name)
name
- the name of the pie columnprotected String getPieColumnName()
protected void setAggregationColumnName(String name)
name
- the name of the aggregation columnprotected String getAggregationColumnName()
protected abstract D getVizModelInternal() throws TooManySectionsException
PieVizModel
. Could be null.
TooManySectionsException
- if more sections are created than
supportedprotected 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 void resetPieData()
protected void loadInternals(File nodeInternDir, ExecutionMonitor exec) throws CanceledExecutionException
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.
CanceledExecutionException
- If the loading has been canceled.NodeModel.saveInternals(File,ExecutionMonitor)
protected abstract void loadPieInternals(File dataDir, ExecutionMonitor exec) throws CanceledExecutionException
dataDir
- the directory load load fromexec
- the ExecutionMonitor
CanceledExecutionException
- if action was canceledprotected void saveInternals(File nodeInternDir, ExecutionMonitor exec) throws IOException, CanceledExecutionException
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.
IOException
- If an error occurs during writing to this dir.
CanceledExecutionException
- If the saving has been canceled.NodeModel.loadInternals(File,ExecutionMonitor)
protected abstract void savePieInternals(File dataDir, ExecutionMonitor exec) throws IOException, CanceledExecutionException
dataDir
- the directory to save toexec
- the ExecutionMonitor
IOException
- file exception
CanceledExecutionException
- action was canceled
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |