org.knime.base.node.preproc.filter.column
Class FilterColumnNodeModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.preproc.filter.column.FilterColumnNodeModel

final class FilterColumnNodeModel
extends NodeModel

The model for the column filter which extracts certain columns from the input DataTable using a list of columns to exclude.

Author:
Christoph Sieb, University of Konstanz, Thomas Gabriel, University of Konstanz

Field Summary
(package private) static String CFG_KEY_SELECTIONOPTION
          Config for the force include/exclude flag.
(package private) static int INPORT
          The input port used here.
(package private) static String KEY
          the excluded settings.
(package private) static int OUTPORT
          The output port used here.
 
Constructor Summary
FilterColumnNodeModel()
          Creates a new filter model with one and in- and output.
 
Method Summary
protected  DataTableSpec[] configure(DataTableSpec[] inSpecs)
          Excludes a number of columns from the input spec and generates a new output spec.
protected  BufferedDataTable[] execute(BufferedDataTable[] data, ExecutionContext exec)
          This function is invoked by the Node#executeNode() method of the node (through the #executeModel(BufferedDataTable[],ExecutionMonitor) method)only after all predecessor nodes have been successfully executed and all data is therefore available at the input ports.
protected  void loadInternals(File nodeInternDir, ExecutionMonitor exec)
          Load internals into the derived NodeModel.
protected  void loadValidatedSettingsFrom(NodeSettingsRO settings)
          Reads the filtered columns.
protected  void reset()
          Resets the internal list of columns to exclude.
protected  void saveInternals(File nodeInternDir, ExecutionMonitor exec)
          Save internals of the derived NodeModel.
protected  void saveSettingsTo(NodeSettingsWO settings)
          Writes number of filtered columns, and the names as DataCell to the given 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

INPORT

static final int INPORT
The input port used here.

See Also:
Constant Field Values

OUTPORT

static final int OUTPORT
The output port used here.

See Also:
Constant Field Values

KEY

static final String KEY
the excluded settings.

See Also:
Constant Field Values

CFG_KEY_SELECTIONOPTION

static final String CFG_KEY_SELECTIONOPTION
Config for the force include/exclude flag.

See Also:
Constant Field Values
Constructor Detail

FilterColumnNodeModel

FilterColumnNodeModel()
Creates a new filter model with one and in- and output.

Method Detail

reset

protected void reset()
Resets the internal list of columns to exclude.

Specified by:
reset in class NodeModel

execute

protected BufferedDataTable[] execute(BufferedDataTable[] data,
                                      ExecutionContext exec)
                               throws Exception
This function is invoked by the Node#executeNode() method of the node (through the #executeModel(BufferedDataTable[],ExecutionMonitor) method)only after all predecessor nodes have been successfully executed and all data is therefore available at the input ports. Implement this function with your task in the derived model.

The input data is available in the given array argument inData and is ensured to be neither null nor contain null elements.

In order to create output data, you need to create objects of class BufferedDataTable. Use the execution context argument to create BufferedDataTable.

Overrides:
execute in class NodeModel
Parameters:
data - An array holding DataTable elements, one for each input.
exec - The execution monitor for this execute method. It provides us with means to create new BufferedDataTable. Additionally, it should be asked frequently if the execution should be interrupted and throws an exception then. This exception might me caught, and then after closing all data streams, been thrown again. Also, if you can tell the progress of your task, just set it in this monitor.
Returns:
An array of non- null DataTable elements with the size of the number of outputs. The result of this execution.
Throws:
Exception - If you must fail the execution. Try to provide a meaningful error message in the exception as it will be displayed to the user.Please be advised to check frequently the canceled status by invoking ExecutionMonitor#checkCanceled which will throw an CanceledExcecutionException and abort the execution.

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)

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)

configure

protected DataTableSpec[] configure(DataTableSpec[] inSpecs)
                             throws InvalidSettingsException
Excludes a number of columns from the input spec and generates a new output spec.

Overrides:
configure in class NodeModel
Parameters:
inSpecs - the input table spec
Returns:
outSpecs the output table spec with some excluded columns
Throws:
InvalidSettingsException - if the selected column is not available in the table spec.

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)
Writes number of filtered columns, and the names as DataCell to the given settings.

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

loadValidatedSettingsFrom

protected void loadValidatedSettingsFrom(NodeSettingsRO settings)
                                  throws InvalidSettingsException
Reads the filtered columns.

Specified by:
loadValidatedSettingsFrom in class NodeModel
Parameters:
settings - to read from
Throws:
InvalidSettingsException - if the settings does not contain the size or a particular column key
See Also:
NodeModel.saveSettingsTo(NodeSettingsWO), 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.