org.knime.base.node.preproc.normalize
Class NormalizerNodeModel

java.lang.Object
  org.knime.core.node.NodeModel
      org.knime.base.node.preproc.normalize.NormalizerNodeModel

Direct Known Subclasses:

NormalizerPMMLNodeModel

public class NormalizerNodeModel
extends NodeModel

The NormalizeNodeModel uses the Normalizer to normalize the input DataTable.

Author:

Nicolas Cebron, University of Konstanz

See Also:

Normalizer

Nested Class Summary

protected class

NormalizerNodeModel.CalculationResult Helper class for being able to return all necessary information in the calculate(PortObject[], ExecutionContext) method.

Field Summary

(package private) static String	CFG_MODEL_NAME The config key under which the model is stored.
(package private) static String	CFG_USE_ALL_NUMERIC Key to store if all numeric columns are used for normalization.
static String	COLUMNS_KEY Key to store the columns to use.
static int	DECIMALSCALING_MODE DECIMAL SCALING mode.
static int	MINMAX_MODE MINMAX mode.
static String	MODE_KEY Key to store the mode.
static String	NEWMAX_KEY Key to store the new maximum value (in min/max mode).
static String	NEWMIN_KEY Key to store the new minimum value (in min/max mode).
static int	NONORM_MODE No Normalization mode.
static int	ZSCORE_MODE ZSCORE mode.

Constructor Summary

	NormalizerNodeModel() Creates an new normalizer.
protected	NormalizerNodeModel(PortType modelPortType)

Method Summary

protected NormalizerNodeModel.CalculationResult	calculate(PortObject[] inData, ExecutionContext exec)
protected PortObjectSpec[]	configure(PortObjectSpec[] inSpecs) All IntCell columns are converted to DoubleCell columns.
protected PortObject[]	execute(PortObject[] inObjects, ExecutionContext exec) Execute method for general port types.
(package private) static String[]	findAllNumericColumns(DataTableSpec spec) Finds all numeric columns in spec.
protected String[]	getColumns()
protected int	getMode()
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 PortObjectSpec[]	prepareConfigure(PortObjectSpec[] inSpecs)
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	setColumns(String[] columns)
protected void	updateNumericColumnSelection(DataTableSpec spec)
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, getAvailableFlowVariables, getCredentialsProvider, getInHiLiteHandler, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutgoingFlowObjectStack, getOutHiLiteHandler, getWarningMessage, notifyViews, notifyWarningListeners, onDispose, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, peekScopeVariableDouble, peekScopeVariableInt, peekScopeVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, pushScopeVariableDouble, pushScopeVariableInt, pushScopeVariableString, removeWarningListener, resetAndConfigureLoopBody, setInHiLiteHandler, setWarningMessage, stateChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NEWMIN_KEY

public static final String NEWMIN_KEY

Key to store the new minimum value (in min/max mode).

See Also:

Constant Field Values

NEWMAX_KEY

public static final String NEWMAX_KEY

Key to store the new maximum value (in min/max mode).

See Also:

Constant Field Values

MODE_KEY

public static final String MODE_KEY

Key to store the mode.

See Also:

Constant Field Values

COLUMNS_KEY

public static final String COLUMNS_KEY

Key to store the columns to use.

See Also:

Constant Field Values

NONORM_MODE

public static final int NONORM_MODE

No Normalization mode.

See Also:

Constant Field Values

MINMAX_MODE

public static final int MINMAX_MODE

MINMAX mode.

See Also:

Constant Field Values

ZSCORE_MODE

public static final int ZSCORE_MODE

ZSCORE mode.

See Also:

Constant Field Values

DECIMALSCALING_MODE

public static final int DECIMALSCALING_MODE

DECIMAL SCALING mode.

See Also:

Constant Field Values

CFG_USE_ALL_NUMERIC

static final String CFG_USE_ALL_NUMERIC

Key to store if all numeric columns are used for normalization.

See Also:

Constant Field Values

CFG_MODEL_NAME

static final String CFG_MODEL_NAME

The config key under which the model is stored.

See Also:

Constant Field Values

Constructor Detail

NormalizerNodeModel

public NormalizerNodeModel()

Creates an new normalizer. One input, two outputs (one of which is the model).

NormalizerNodeModel

protected NormalizerNodeModel(PortType modelPortType)

Parameters:

modelPortType - the port type of the model

Method Detail

prepareConfigure

protected PortObjectSpec[] prepareConfigure(PortObjectSpec[] inSpecs)
                                     throws InvalidSettingsException

Parameters:

inSpecs - An array of DataTableSpecs (as many as this model has inputs).

Returns:

An array of DataTableSpecs (as many as this model has outputs)

Throws:

InvalidSettingsException - if the #configure() failed, that is, the settings are inconsistent with given DataTableSpec elements.

getColumns

protected String[] getColumns()

Returns:

the columns used for normalization.

configure

protected PortObjectSpec[] configure(PortObjectSpec[] inSpecs)
                              throws InvalidSettingsException

All IntCell columns are converted to DoubleCell columns. 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:

inSpecs - The input data table specs. Items of the array could be null if no spec is available from the corresponding input port (i.e. not connected or upstream node does not produce an output spec). If a port is of type BufferedDataTable.TYPE and no spec is available the framework will replace null by an empty DataTableSpec (no columns) unless the port is marked as optional.

Returns:

The output objects specs or null.

Throws:

InvalidSettingsException - If this node can't be configured.

updateNumericColumnSelection

protected void updateNumericColumnSelection(DataTableSpec spec)
                                     throws InvalidSettingsException

Parameters:

spec - the data table spec

Throws:

InvalidSettingsException - if no normalization mode is set

findAllNumericColumns

static final String[] findAllNumericColumns(DataTableSpec spec)

Finds all numeric columns in spec.

Parameters:

spec - input table spec

Returns:

array of numeric column names

execute

protected PortObject[] execute(PortObject[] inObjects,
                               ExecutionContext exec)
                        throws Exception

Execute method for general port types. The argument objects represent the input objects and are guaranteed to be subclasses of the 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.

Overrides:

execute in class NodeModel

Parameters:

inObjects - The input objects.

exec - For BufferedDataTable creation and progress.

Returns:

The output objects.

Throws:

Exception - If the node execution fails for any reason.

calculate

protected NormalizerNodeModel.CalculationResult calculate(PortObject[] inData,
                                                          ExecutionContext exec)
                                                   throws Exception

Parameters:

inData - The input data.

exec - For BufferedDataTable creation and progress.

Returns:

the result of the calculation

Throws:

Exception - If the node calculation fails for any reason.

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)

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)

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

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)

setColumns

protected void setColumns(String[] columns)

Parameters:

columns - the columns to set

getMode

protected int getMode()

Returns:

the mode