org.knime.base.node.mine.subgroupminer
Class SubgroupMinerModel

java.lang.Object
  extended by org.knime.core.node.NodeModel
      extended by org.knime.base.node.mine.subgroupminer.SubgroupMinerModel
All Implemented Interfaces:
HiLiteMapper

public class SubgroupMinerModel
extends NodeModel
implements HiLiteMapper

The SubgroupMinerModel searches for frequent itemsets with an apriori algorithm using a prefixtree structure.

Author:
Fabian Dill, University of Konstanz

Field Summary
static String CFG_ASSOCIATION_RULES
          Config key if association rules should be output.
static String CFG_BITVECTOR_COL
          Config key for the column containing the transactions as bitvectors.
static String CFG_CONFIDENCE
          Config key for the confidence of the association rules.
static String CFG_ITEMSET_TYPE
          Config key for the itemset type (free, closed or maximal).
static String CFG_MAX_ITEMSET_LENGTH
          Config key for the maximal itemset length.
static String CFG_MIN_SUPPORT
          Config key for the minimum support.
static String CFG_SORT_BY
          Config key for the sorting method.
static String CFG_UNDERLYING_STRUCT
          Config key for the algorithm to use.
static double DEFAULT_CONFIDENCE
          Default value for the confidence.
static int DEFAULT_MAX_ITEMSET_LENGTH
          Default value for the maximal itemset length.
static double DEFAULT_MIN_SUPPORT
          Default value for the minimum support.
 
Constructor Summary
SubgroupMinerModel()
          Creates an instance of the SubgroubMinerModel.
 
Method Summary
protected  DataTableSpec[] configure(DataTableSpec[] inSpecs)
          This function is called whenever the derived model should re-configure its output DataTableSpecs.
protected  BufferedDataTable[] execute(BufferedDataTable[] inData, 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.
 DataTable getItemSetTable()
          Returns the frequent itemsets as a table.
 Set<RowKey> getKeys(RowKey key)
          Returns a set of RowKey elements which are associated by the specified key or null if no mapping is available.
 double getMinSupport()
          Returns the minimum support.
 Set<RowKey> keySet()
          Returns an unmodifiable set of key (source) for hiliting.
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_BITVECTOR_COL

public static final String CFG_BITVECTOR_COL
Config key for the column containing the transactions as bitvectors.

See Also:
Constant Field Values

CFG_MIN_SUPPORT

public static final String CFG_MIN_SUPPORT
Config key for the minimum support.

See Also:
Constant Field Values

CFG_MAX_ITEMSET_LENGTH

public static final String CFG_MAX_ITEMSET_LENGTH
Config key for the maximal itemset length.

See Also:
Constant Field Values

CFG_ITEMSET_TYPE

public static final String CFG_ITEMSET_TYPE
Config key for the itemset type (free, closed or maximal).

See Also:
Constant Field Values

CFG_SORT_BY

public static final String CFG_SORT_BY
Config key for the sorting method.

See Also:
Constant Field Values

CFG_ASSOCIATION_RULES

public static final String CFG_ASSOCIATION_RULES
Config key if association rules should be output.

See Also:
Constant Field Values

CFG_CONFIDENCE

public static final String CFG_CONFIDENCE
Config key for the confidence of the association rules.

See Also:
Constant Field Values

CFG_UNDERLYING_STRUCT

public static final String CFG_UNDERLYING_STRUCT
Config key for the algorithm to use.

See Also:
Constant Field Values

DEFAULT_MIN_SUPPORT

public static final double DEFAULT_MIN_SUPPORT
Default value for the minimum support.

See Also:
Constant Field Values

DEFAULT_MAX_ITEMSET_LENGTH

public static final int DEFAULT_MAX_ITEMSET_LENGTH
Default value for the maximal itemset length.

See Also:
Constant Field Values

DEFAULT_CONFIDENCE

public static final double DEFAULT_CONFIDENCE
Default value for the confidence.

See Also:
Constant Field Values
Constructor Detail

SubgroupMinerModel

public SubgroupMinerModel()
Creates an instance of the SubgroubMinerModel.

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 BufferedDataTable[] execute(BufferedDataTable[] inData,
                                      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:
inData - 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.

getItemSetTable

public DataTable getItemSetTable()
Returns the frequent itemsets as a table.

Returns:
the frequent itemsets

getMinSupport

public double getMinSupport()
Returns the minimum support.

Returns:
the minimum support

getKeys

public Set<RowKey> getKeys(RowKey key)
Returns a set of RowKey elements which are associated by the specified key or null if no mapping is available.

Specified by:
getKeys in interface HiLiteMapper
Parameters:
key - the key to get the mapping for
Returns:
a set of mapped RowKey elements

keySet

public Set<RowKey> keySet()
Returns an unmodifiable set of key (source) for hiliting.

Specified by:
keySet in interface HiLiteMapper
Returns:
A set of keys to hilite.

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 DataTableSpec[] configure(DataTableSpec[] inSpecs)
                             throws InvalidSettingsException
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.

loadInternals

protected void loadInternals(File internDir,
                             ExecutionMonitor exec)
                      throws IOException
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.
See Also:
NodeModel.saveInternals(File,ExecutionMonitor)

saveInternals

protected void saveInternals(File internDir,
                             ExecutionMonitor exec)
                      throws IOException
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.
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.