org.knime.base.node.preproc.sorter
Class SorterNodeModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.preproc.sorter.SorterNodeModel

public class SorterNodeModel
extends NodeModel

This class implements the NodeModel for the sorter node. The input table is segmented into containers that are sorted with guaranteed n*log(n) performance, based on a selection of columns and a corresponding order (ascending/descending). In the end, all sorted containers are merged together and transformed in a output datatable. To compare two datarows, the Comparator compares the DataCells with their compareTo-method on each position.

Author:
Nicolas Cebron, University of Konstanz
See Also:
DataContainer, Arrays.sort(java.lang.Object[], int, int, java.util.Comparator)

Field Summary
(package private) static String INCLUDELIST_KEY
          The key for the IncludeList in the NodeSettings.
(package private) static int INPORT
          The input port used here.
(package private) static int OUTPORT
          The output port used here.
(package private) static String SORTINMEMORY_KEY
          The key for the memory-sort flag in the NodeSettings.
(package private) static String SORTORDER_KEY
          The key for the Sort Order Array in the NodeSettings.
 
Constructor Summary
SorterNodeModel()
          Inits a new SorterNodeModel with one in- and one output.
 
Method Summary
protected  DataTableSpec[] configure(DataTableSpec[] inSpecs)
          Check if the values of the include list also exist in the DataTableSpec at the inport.
protected  BufferedDataTable[] execute(BufferedDataTable[] inData, ExecutionContext exec)
          When the model gets executed, the DataTable is split in several DataContainers.
protected  void loadInternals(File nodeInternDir, ExecutionMonitor exec)
          Load internals into the derived NodeModel.
protected  void loadValidatedSettingsFrom(NodeSettingsRO settings)
          Load the settings (includelist and sort order) in the SorterNodeModel.
 void reset()
          Resets all internal data.
protected  void saveInternals(File nodeInternDir, ExecutionMonitor exec)
          Save internals of the derived NodeModel.
protected  void saveSettingsTo(NodeSettingsWO settings)
          The list of included columns and their sort order are stored in the settings.
protected  void validateSettings(NodeSettingsRO settings)
          Valid settings should contain the list of columns and a corresponding sort order array of same size.
 
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

INCLUDELIST_KEY

static final String INCLUDELIST_KEY
The key for the IncludeList in the NodeSettings.

See Also:
Constant Field Values

SORTORDER_KEY

static final String SORTORDER_KEY
The key for the Sort Order Array in the NodeSettings.

See Also:
Constant Field Values

SORTINMEMORY_KEY

static final String SORTINMEMORY_KEY
The key for the memory-sort flag in the NodeSettings.

See Also:
Constant Field Values
Constructor Detail

SorterNodeModel

SorterNodeModel()
Inits a new SorterNodeModel with one in- and one output.

Method Detail

execute

protected BufferedDataTable[] execute(BufferedDataTable[] inData,
                                      ExecutionContext exec)
                               throws Exception
When the model gets executed, the DataTable is split in several DataContainers. Each one is first removed, then swapped back into memory, gets sorted and is then removed again. At the end, all containers are merged together in one Result-Container. The list of columns that shall be sorted and their corresponding sort order in a boolean array should be set, before executing the model.

Overrides:
execute in class NodeModel
Parameters:
inData - the data table at the input port
exec - the execution monitor
Returns:
the sorted data table
Throws:
Exception - if the settings (includeList and sortOrder) are not set
See Also:
sort(java.lang.Object[], int, int, java.util.Comparator), NodeModel.execute(BufferedDataTable[], ExecutionContext)

reset

public void reset()
Resets all internal data.

Specified by:
reset in class NodeModel

configure

protected DataTableSpec[] configure(DataTableSpec[] inSpecs)
                             throws InvalidSettingsException
Check if the values of the include list also exist in the DataTableSpec at the inport. If everything is ok, the v from the inport is translated without modification to the outport. This function is called whenever the derived model should re-configure its output DataTableSpecs. Based on the given input data table spec(s) and the current model's settings, the derived model has to calculate the output data table spec and return them.

The passed DataTableSpec elements are never null but can be empty. The model may return null data table spec(s) for the outputs. But still, the model may be in an executable state. Note, after the model has been executed this function will not be called anymore, as the output DataTableSpecs are then being pulled from the output DataTables. A derived NodeModel that cannot provide any DataTableSpecs at its outputs before execution (because the table structure is unknown at this point) can return an array containing just null elements.

Implementation note: This method is called from the NodeModel.configure(PortObjectSpec[]) method unless that method is overwritten.

Overrides:
configure in class NodeModel
Parameters:
inSpecs - An array of DataTableSpecs (as many as this model has inputs). Do NOT modify the contents of this array. None of the DataTableSpecs in the array can be null but empty. If the predecessor node is not yet connected, or doesn't provide a DataTableSpecs at its output port.
Returns:
An array of DataTableSpecs (as many as this model has outputs) They will be propagated to connected successor nodes. null DataTableSpec elements are changed to empty once.
Throws:
InvalidSettingsException - if the #configure() failed, that is, the settings are inconsistent with given DataTableSpec elements.

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)
The list of included columns and their sort order are stored 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
Valid settings should contain the list of columns and a corresponding sort order array of same size. 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
Load the settings (includelist and sort order) in the SorterNodeModel. 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)

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)


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.