org.knime.base.node.preproc.discretization.caim2.modelcreator
Class CAIMDiscretizationNodeModel

java.lang.Object
  org.knime.core.node.NodeModel
      org.knime.base.node.preproc.discretization.caim2.modelcreator.CAIMDiscretizationNodeModel

public class CAIMDiscretizationNodeModel
extends NodeModel

Implements the CAIM discretization algorithm. The algorithm is based on the publication of Kurgan and Cios (2004) and performs a discretization based on a Class-Interval interdependance measure. The algorithm therefore incorporates the class information (supervised discretization)

Author:

Christoph Sieb, University of Konstanz

See Also:

CAIMDiscretization2NodeFactory

Field Summary

(package private) static int	DATA_INPORT index of the port receiving data.
(package private) static int	DATA_OUTPORT index of the port providing output data.
(package private) static int	MODEL_OUTPORT index of the port providing the model.
static String	USE_CLASS_OPTIMIZATION Key to store whether the class optimized version should be applied.

Constructor Summary

CAIMDiscretizationNodeModel()
Initializes a new CAIM model with one data in- and one data output port.

Method Summary

protected PortObjectSpec[]	configure(PortObjectSpec[] inSpecs) The number of the class columns must be > 0 and < number of input columns.
(package private) static SettingsModelString	createClassColModel()
(package private) static SettingsModelFilterString	createIncludeColsModel()
static BufferedDataTable	createResultTable(ExecutionContext exec, BufferedDataTable table, DiscretizationModel discretizationModel) Creates BufferedDataTable from a given input table and an appropriate DiscretizationScheme.
(package private) static SettingsModelBoolean	createSortInMemModel()
protected PortObject[]	execute(PortObject[] inData, ExecutionContext exec) Execute method for general port types.
(package private) static DiscretizationScheme[]	filterNotKnownSchemes(DiscretizationScheme[] schemes, String[] schemeColumnNames, DataTableSpec spec) Filters out all schemes for which the corresponding column is not part of the given table spec.
DiscretizationModel	getDiscretizationModel() Returns the discretization node model of this node.
protected void	loadInternals(File nodeInternDir, ExecutionMonitor exec) Load internals into the derived NodeModel.
protected void	loadValidatedSettingsFrom(NodeSettingsRO settings) Loads the class column and the classification value in the model.
protected void	reset() Resets all internal data.
protected void	saveInternals(File nodeInternDir, ExecutionMonitor exec) Save internals of the derived NodeModel.
protected void	saveSettingsTo(NodeSettingsWO settings) Saves the class column and the classification value in the settings.
protected void	validateSettings(NodeSettingsRO settings) This method validates the settings.

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

USE_CLASS_OPTIMIZATION

public static final String USE_CLASS_OPTIMIZATION

Key to store whether the class optimized version should be applied.

See Also:

Constant Field Values

DATA_INPORT

static final int DATA_INPORT

index of the port receiving data.

See Also:

Constant Field Values

MODEL_OUTPORT

static final int MODEL_OUTPORT

index of the port providing the model.

See Also:

Constant Field Values

DATA_OUTPORT

static final int DATA_OUTPORT

index of the port providing output data.

See Also:

Constant Field Values

Constructor Detail

CAIMDiscretizationNodeModel

public CAIMDiscretizationNodeModel()

Initializes a new CAIM model with one data in- and one data output port.

Method Detail

execute

protected PortObject[] execute(PortObject[] inData,
                               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:

inData - The input objects.

exec - For BufferedDataTable creation and progress.

Returns:

The output objects.

Throws:

Exception - If the node execution fails for any reason.

filterNotKnownSchemes

static DiscretizationScheme[] filterNotKnownSchemes(DiscretizationScheme[] schemes,
                                                    String[] schemeColumnNames,
                                                    DataTableSpec spec)

Filters out all schemes for which the corresponding column is not part of the given table spec.

Parameters:

schemes - the scheme to filter

schemeColumnNames - the column names for the given schemes

spec - the spec used as filter criteria

Returns:

filtered discretization schemes only containing schemes for which the corresponding column is contained in the given spec

createResultTable

public static BufferedDataTable createResultTable(ExecutionContext exec,
                                                  BufferedDataTable table,
                                                  DiscretizationModel discretizationModel)

Creates BufferedDataTable from a given input table and an appropriate DiscretizationScheme. The result table has replaced columns according to the DiscretizationScheme.

Parameters:

exec - the context from which to create the BufferedDataTable

table - the input data table

discretizationModel - the DiscretizationModel that contains the mapping from numerical intervals to nominal String values for the included columns

Returns:

the discretized input data

reset

protected void reset()

Resets all internal data.

Specified by:

reset in class NodeModel

configure

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

The number of the class columns must be > 0 and < number of input columns. Also create the output table spec replacing the columns to discretize to nominal String values. 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.

loadValidatedSettingsFrom

protected void loadValidatedSettingsFrom(NodeSettingsRO settings)
                                  throws InvalidSettingsException

Loads the class column and the classification value in the model. 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)

Saves the class column and the classification value in the 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

This method validates the settings. That is:

• The number of the class column must be an integer > 0
• The positive value DataCell must not be null

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)

getDiscretizationModel

public DiscretizationModel getDiscretizationModel()

Returns the discretization node model of this node.

Returns:

the discretization node model of this node

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)

createClassColModel

static SettingsModelString createClassColModel()

Returns:

a new model for holding the selected class column name

createSortInMemModel

static SettingsModelBoolean createSortInMemModel()

Returns:

a new model to store the user settings

createIncludeColsModel

static SettingsModelFilterString createIncludeColsModel()

Returns:

a new model to store the user settings