org.knime.base.node.viz.property.shape
Class ShapeManagerNodeModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.viz.property.shape.ShapeManagerNodeModel

 class ShapeManagerNodeModel
extends NodeModel

Model used to set shapes by nominal values retrieved from the DataColumnSpec domain. The created ShapeHandler is then set in the column spec.

Author:
Thomas Gabriel, University of Konstanz
See Also:
ShapeManagerNodeDialogPane, ShapeHandler

Field Summary
(package private) static int INPORT
          Keeps port number for the single input port.
(package private) static NodeLogger LOGGER
          Logger for this package.
(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
ShapeManagerNodeModel()
          Creates a new model for mapping shapes.
 
Method Summary
(package private) static DataTableSpec appendShapeHandler(DataTableSpec spec, String column, ShapeHandler shapeHandler)
          Appends the given ShapeHandler to the given DataTableSpec for the given column.
protected  PortObjectSpec[] configure(PortObjectSpec[] inPorts)
          Configure method for general port types.
protected  PortObject[] execute(PortObject[] data, ExecutionContext exec)
          Is invoked during the node's execution to make the shape settings.
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  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 validateSettings(NodeSettingsRO settings)
          Validates the settings in the passed NodeSettings object.
 
Methods inherited from class org.knime.core.node.NodeModel
addWarningListener, configure, continueLoop, execute, executeModel, getInHiLiteHandler, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getWarningMessage, notifyViews, notifyWarningListeners, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, peekScopeVariableDouble, peekScopeVariableInt, peekScopeVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, pushScopeVariableDouble, pushScopeVariableInt, pushScopeVariableString, removeWarningListener, setInHiLiteHandler, setWarningMessage, stateChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGER

static final NodeLogger LOGGER
Logger for this package.


INPORT

static final int INPORT
Keeps port number for the single input port.

See Also:
Constant Field Values

OUTPORT

static final int OUTPORT
Keeps port number for the single input port.

See Also:
Constant Field Values

SELECTED_COLUMN

static final String SELECTED_COLUMN
Keeps the selected column.

See Also:
Constant Field Values

VALUES

static final String VALUES
The nominal column values.

See Also:
Constant Field Values
Constructor Detail

ShapeManagerNodeModel

ShapeManagerNodeModel()
Creates a new model for mapping shapes.

Method Detail

execute

protected PortObject[] execute(PortObject[] data,
                               ExecutionContext exec)
                        throws CanceledExecutionException
Is invoked during the node's execution to make the shape settings.

Overrides:
execute in class NodeModel
Parameters:
data - the input data array
exec - the execution monitor
Returns:
the same input data table with assigned shapes to one column
Throws:
CanceledExecutionException - if user canceled execution
See Also:
NodeModel.execute(BufferedDataTable[],ExecutionContext)

appendShapeHandler

static final DataTableSpec appendShapeHandler(DataTableSpec spec,
                                              String column,
                                              ShapeHandler shapeHandler)
Appends the given ShapeHandler to the given DataTableSpec for the given column. If the spec already contains a ShapeHandler, it will be removed and replaced by the new one.

Parameters:
spec - to which the ShapeHandler is appended
column - for this column
shapeHandler - ShapeHandler
Returns:
a new spec with ShapeHandler

reset

protected void reset()
Override this function in the derived model and reset your 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.

Specified by:
reset in class NodeModel

loadInternals

protected void loadInternals(File nodeInternDir,
                             ExecutionMonitor exec)
                      throws IOException,
                             CanceledExecutionException
Load internals into the derived 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.

Specified by:
loadInternals in class NodeModel
Parameters:
nodeInternDir - The directory to read from.
exec - Used to report progress and to cancel the load process.
Throws:
IOException - If an error occurs during reading from this dir.
CanceledExecutionException - If the loading has been canceled.
See Also:
NodeModel.saveInternals(File,ExecutionMonitor)

saveInternals

protected void saveInternals(File nodeInternDir,
                             ExecutionMonitor exec)
                      throws IOException,
                             CanceledExecutionException
Save internals of the derived 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.

Specified by:
saveInternals in class NodeModel
Parameters:
nodeInternDir - The directory to write into.
exec - Used to report progress and to cancel the save process.
Throws:
IOException - If an error occurs during writing to this dir.
CanceledExecutionException - If the saving has been canceled.
See Also:
NodeModel.loadInternals(File,ExecutionMonitor)

configure

protected PortObjectSpec[] configure(PortObjectSpec[] inPorts)
                              throws InvalidSettingsException
Configure method for general port types. The argument specs represent the input object specs and are guaranteed to be subclasses of the 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.

Overrides:
configure in class NodeModel
Parameters:
inPorts - The input object specs.
Returns:
The output objects specs or null.
Throws:
InvalidSettingsException - If this node can't be configured.

loadValidatedSettingsFrom

protected void loadValidatedSettingsFrom(NodeSettingsRO settings)
                                  throws InvalidSettingsException
Sets new settings from the passed object in the model. You can safely assume that the object passed has been successfully validated by the #validateSettings(NodeSettings) method. The model must set its internal configuration according to the settings object passed.

Specified by:
loadValidatedSettingsFrom in class NodeModel
Parameters:
settings - The settings to read.
Throws:
InvalidSettingsException - If a property is not available.
See Also:
NodeModel.saveSettingsTo(NodeSettingsWO), NodeModel.validateSettings(NodeSettingsRO)

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)
Adds to the given 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.

Specified by:
saveSettingsTo in class NodeModel
Parameters:
settings - The object to write settings into.
See Also:
NodeModel.loadValidatedSettingsFrom(NodeSettingsRO), NodeModel.validateSettings(NodeSettingsRO)

validateSettings

protected void validateSettings(NodeSettingsRO settings)
                         throws InvalidSettingsException
Validates the settings in the passed 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.

Specified by:
validateSettings in class NodeModel
Parameters:
settings - The settings to validate.
Throws:
InvalidSettingsException - If the validation of the settings failed.
See Also:
NodeModel.saveSettingsTo(NodeSettingsWO), NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.