org.knime.base.node.mine.regression.linear.learn
Class LinRegLearnerNodeModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.mine.regression.linear.learn.LinRegLearnerNodeModel
All Implemented Interfaces:
LinRegDataProvider, DataProvider

public class LinRegLearnerNodeModel
extends NodeModel
implements LinRegDataProvider

NodeModel to the linear regression learner node. It performs the calculation.

Author:
Bernd Wiswedel, University of Konstanz

Field Summary
(package private) static String CFG_CALC_ERROR
          Key for flag if to compute error on training data.
(package private) static String CFG_FROMROW
          Settings object key for the starting row.
(package private) static String CFG_ROWCNT
          Settings object key for the number of row to display.
(package private) static String CFG_TARGET
          Key for the target column, used for dialog settings.
(package private) static String CFG_VARIATES
          Key for the included columns, used for dialog settings.
(package private) static String CFG_VARIATES_USE_ALL
          Key for whether to include all appropriate columns by default.
 
Fields inherited from interface org.knime.base.node.viz.plotter.DataProvider
END, START
 
Constructor Summary
LinRegLearnerNodeModel()
          Inits a new node model, it will have 1 data input and 1 model output.
 
Method Summary
protected  PortObjectSpec[] configure(PortObjectSpec[] inSpecs)
          Configure method for general port types.
protected  PortObject[] execute(PortObject[] inData, ExecutionContext exec)
          Execute method for general port types.
 DataArray getDataArray(int index)
          Provides the data that should be visualized.
protected  double getError()
           
 String[] getLearningColumns()
          
protected  int getNrRows()
           
protected  int getNrRowsSkipped()
           
 LinearRegressionContent getParams()
          Get all parameters to the currently learned model.
 DataArray getRowContainer()
          Get the row container for the rows to paint in the view.
protected  boolean isCalcError()
           
protected  boolean isDataAvailable()
          Returns true if model is avaiable, i.e.
protected  void loadInternals(File internDir, 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 internDir, 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

CFG_FROMROW

static final String CFG_FROMROW
Settings object key for the starting row.

See Also:
Constant Field Values

CFG_ROWCNT

static final String CFG_ROWCNT
Settings object key for the number of row to display.

See Also:
Constant Field Values

CFG_VARIATES

static final String CFG_VARIATES
Key for the included columns, used for dialog settings.

See Also:
Constant Field Values

CFG_VARIATES_USE_ALL

static final String CFG_VARIATES_USE_ALL
Key for whether to include all appropriate columns by default.

See Also:
Constant Field Values

CFG_TARGET

static final String CFG_TARGET
Key for the target column, used for dialog settings.

See Also:
Constant Field Values

CFG_CALC_ERROR

static final String CFG_CALC_ERROR
Key for flag if to compute error on training data.

See Also:
Constant Field Values
Constructor Detail

LinRegLearnerNodeModel

public LinRegLearnerNodeModel()
Inits a new node model, it will have 1 data input and 1 model output.

Method Detail

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)

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)

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.

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

configure

protected PortObjectSpec[] configure(PortObjectSpec[] inSpecs)
                              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:
inSpecs - The input object specs.
Returns:
The output objects specs or null.
Throws:
InvalidSettingsException - If this node can't be configured.

getNrRows

protected int getNrRows()
Returns:
the nrRowsProcessed.

getNrRowsSkipped

protected int getNrRowsSkipped()
Returns:
the nrRowsSkipped.

isDataAvailable

protected boolean isDataAvailable()
Returns true if model is avaiable, i.e. node has been executed.

Returns:
if model has been executed

getParams

public LinearRegressionContent getParams()
Get all parameters to the currently learned model.

Specified by:
getParams in interface LinRegDataProvider
Returns:
a reference to the current values
See Also:
LinRegDataProvider.getParams()

getRowContainer

public DataArray getRowContainer()
Get the row container for the rows to paint in the view.

Specified by:
getRowContainer in interface LinRegDataProvider
Returns:
the rows to paint

getDataArray

public DataArray getDataArray(int index)
Provides the data that should be visualized. The index can be used, if a NodeModel has two inports and both data should be visualized. Then the index provides means to determine which DataArray should be returned.

Specified by:
getDataArray in interface DataProvider
Parameters:
index - if the data of more than one data table should be visualized.
Returns:
the data as a data array.

getLearningColumns

public String[] getLearningColumns()

Specified by:
getLearningColumns in interface LinRegDataProvider
Returns:
those columns which were used to calculate the model

getError

protected double getError()
Returns:
the error

isCalcError

protected boolean isCalcError()
Returns:
the isCalcError

loadInternals

protected void loadInternals(File internDir,
                             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:
internDir - 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 internDir,
                             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:
internDir - 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)


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.