|
||||||||||
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.property.color.ColorManager2NodeModel
class ColorManager2NodeModel
Model used to set colors either based on the nominal values or ranges
(bounds) retrieved from the DataColumnSpec
.
The created ColorHandler
is then
set in the column spec.
ColorManager2NodeDialogPane
Field Summary | |
---|---|
(package private) static int |
INPORT
Keeps port number for the single input port. |
(package private) static String |
IS_NOMINAL
Type of color setting. |
(package private) static NodeLogger |
LOGGER
Logger for this package. |
(package private) static String |
MAX_COLOR
The maximum column value for range color settings. |
(package private) static String |
MIN_COLOR
The minimum column value for range color settings. |
(package private) static int |
OUTPORT
Keeps port number for the single input port. |
(package private) static String |
SELECTED_COLUMN
Keeps the selected column. |
(package private) static String |
VALUES
The nominal column values. |
Constructor Summary | |
---|---|
ColorManager2NodeModel()
Creates a new model for mapping colors. |
Method Summary | |
---|---|
protected PortObjectSpec[] |
configure(PortObjectSpec[] inSpecs)
Configure method for general port types. |
protected PortObject[] |
execute(PortObject[] data,
ExecutionContext exec)
Is invoked during the node's execution to make the color settings. |
(package private) static DataTableSpec |
getOutSpec(DataTableSpec spec,
String columnName,
ColorHandler colorHdl)
Appends the given ColorHandler to the given
DataTableSpec for the given column. |
protected void |
loadInternals(File nodeInternDir,
ExecutionMonitor exec)
Load internals into the derived NodeModel . |
protected void |
loadValidatedSettingsFrom(NodeSettingsRO settings)
Load color settings. |
protected void |
reset()
Override this function in the derived model and reset your NodeModel . |
protected void |
saveInternals(File nodeInternDir,
ExecutionMonitor exec)
Save internals of the derived NodeModel . |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Save color settings. |
protected void |
validateSettings(NodeSettingsRO settings)
Validate the color settings, that are, column name must be available, as well as, a color model either nominal or range that contains a color mapping, from each possible value to a color or from min and max value to color, respectively. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
static final NodeLogger LOGGER
static final int INPORT
static final int OUTPORT
static final String SELECTED_COLUMN
static final String VALUES
static final String MIN_COLOR
static final String MAX_COLOR
static final String IS_NOMINAL
Constructor Detail |
---|
public ColorManager2NodeModel()
Method Detail |
---|
protected PortObject[] execute(PortObject[] data, ExecutionContext exec) throws CanceledExecutionException
execute
in class NodeModel
data
- the input data arrayexec
- the execution monitor
CanceledExecutionException
- if user canceled executionstatic final DataTableSpec getOutSpec(DataTableSpec spec, String columnName, ColorHandler colorHdl)
ColorHandler
to the given
DataTableSpec
for the given column. If the spec
already contains a ColorHandler, it will be removed and replaced by
the new one.
spec
- to which the ColorHandler is appendedcolumnName
- for this columncolorHdl
- ColorHandler
protected PortObjectSpec[] configure(PortObjectSpec[] inSpecs) throws InvalidSettingsException
NodeModel
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 specs passed to the output port
InvalidSettingsException
- if a column is not availableprotected void loadValidatedSettingsFrom(NodeSettingsRO settings) throws InvalidSettingsException
loadValidatedSettingsFrom
in class NodeModel
settings
- Used to read color settings from.
InvalidSettingsException
- If a color property with the settings
is invalid.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void saveSettingsTo(NodeSettingsWO settings)
saveSettingsTo
in class NodeModel
settings
- Used to write color settings into.NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void validateSettings(NodeSettingsRO settings) throws InvalidSettingsException
validateSettings
in class NodeModel
settings
- Color settings to validate.
InvalidSettingsException
- If a color property read from the
settings is invalid.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
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 NodeModel
protected void loadInternals(File nodeInternDir, ExecutionMonitor exec) throws IOException, 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.
IOException
- If an error occurs during reading from this dir.
CanceledExecutionException
- If the loading has been canceled.NodeModel.saveInternals(File,ExecutionMonitor)
protected 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |