org.knime.base.node.preproc.sample
Class AbstractSamplingNodeModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.preproc.sample.AbstractSamplingNodeModel
Direct Known Subclasses:
PartitionNodeModel, SamplingNodeModel

public abstract class AbstractSamplingNodeModel
extends NodeModel

NodeModel implementation to sample rows from an input table, thus, this node has one inport. The number of outports is defined by the derived class

Author:
Bernd Wiswedel, University of Konstanz
See Also:
SamplingNodeModel, PartitionNodeModel

Constructor Summary
AbstractSamplingNodeModel(int outs)
          Empty constructor, defines one inport and a given number of outports.
 
Method Summary
protected  void checkSettings(DataTableSpec inSpec)
          Checks if the node settings are valid, i.e.
protected  RowFilter getSamplingRowFilter(BufferedDataTable in, ExecutionMonitor exec)
          Method to be used in the execute method to determine the row filter for the sampling.
 SamplingNodeSettings getSettings()
          Returns the settings of this object.
protected  boolean hasBeenConfigured()
          Deprecated. use checkSettings(DataTableSpec) instead because this also checks for the class column if stratified sampling has been selected
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, configure, continueLoop, execute, 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
 

Constructor Detail

AbstractSamplingNodeModel

public AbstractSamplingNodeModel(int outs)
Empty constructor, defines one inport and a given number of outports.

Parameters:
outs - the number of outports
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)

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)

getSamplingRowFilter

protected RowFilter getSamplingRowFilter(BufferedDataTable in,
                                         ExecutionMonitor exec)
                                  throws CanceledExecutionException,
                                         InvalidSettingsException
Method to be used in the execute method to determine the row filter for the sampling.

Parameters:
in - the data table from the inport
exec - the execution monitor to check for cancelation
Returns:
a row filter for sampling according to current settings
Throws:
CanceledExecutionException - if exec request canceling
InvalidSettingsException - if current settings are invalid

hasBeenConfigured

@Deprecated
protected boolean hasBeenConfigured()
Deprecated. use checkSettings(DataTableSpec) instead because this also checks for the class column if stratified sampling has been selected

Has the node been configured, i.e. a method has been set

Returns:
true if the node is configured

checkSettings

protected void checkSettings(DataTableSpec inSpec)
                      throws InvalidSettingsException
Checks if the node settings are valid, i.e. a method has been set and the class column exists if stratified sampling has been chosen.

Parameters:
inSpec - the input table's spec
Throws:
InvalidSettingsException - if the settings are invalid

getSettings

public SamplingNodeSettings getSettings()
Returns the settings of this object.

Returns:
a reference to the the settings


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.