org.knime.base.node.mine.bayes.naivebayes.predictor3

Class NaiveBayesPredictorNodeModel2

java.lang.Object

org.knime.core.node.NodeModel

org.knime.base.node.mine.bayes.naivebayes.predictor3.NaiveBayesPredictorNodeModel2

public class NaiveBayesPredictorNodeModel2
extends NodeModel

This is the NodeModel implementation of the "Naive Bayes Predictor" node.

Since:

2.10

Author:

Tobias Koetter, KNIME.com, Zurich, Switzerland

Constructor Summary

Constructors

Constructor and Description
NaiveBayesPredictorNodeModel2() Constructor for class NaiveBayesPredictorNodeModel.

Method Summary

Modifier and Type	Method and Description
protected PortObjectSpec[]	configure(PortObjectSpec[] inSpecs) Configure method for general port types.
(package private) static SettingsModelBoolean	createNormalizeModel()
(package private) static SettingsModelBoolean	createProbabilityColumnModel()
StreamableOperator	createStreamableOperator(PartitionInfo partitionInfo, PortObjectSpec[] inSpecs) Streaming API (pending): Factory method for a streamable operator that is used to execute this node.
PortObject[]	execute(PortObject[] inData, ExecutionContext exec) Execute method for general port types.
InputPortRole[]	getInputPortRoles() Streaming API (pending): Defines properties on the input ports when used in a streamed and/or distributed fashion.
OutputPortRole[]	getOutputPortRoles() Streaming API (pending): Similar to NodeModel.getInputPortRoles() describes the role of the output.
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, computeFinalOutputSpecs, configure, continueLoop, createInitialStreamableOperatorInternals, createMergeOperator, execute, finishStreamableExecution, getAvailableFlowVariables, getAvailableInputFlowVariables, getCredentialsProvider, getInHiLiteHandler, getInPortType, getInteractiveNodeView, getLogger, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getOutPortType, getWarningMessage, iterate, notifyViews, notifyWarningListeners, onDispose, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, removeWarningListener, resetAndConfigureLoopBody, setInHiLiteHandler, setWarningMessage, stateChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NaiveBayesPredictorNodeModel2

public NaiveBayesPredictorNodeModel2()

Constructor for class NaiveBayesPredictorNodeModel.

Method Detail

createProbabilityColumnModel

static SettingsModelBoolean createProbabilityColumnModel()

Returns:

include probability column model

createNormalizeModel

static SettingsModelBoolean createNormalizeModel()

Returns:

the normalize model

execute

public PortObject[] execute(PortObject[] inData,
                            ExecutionContext exec)
                     throws Exception

Execute method for general port types. The argument inObjects represent the input objects and the returned array represents the output objects. The elements in the argument array are generally guaranteed to be not null and 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) and must not be null. There are few exceptions to these rules:

• Nodes with optional inputs (as specified in the constructor) may find null elements in the array.
• Node that implement InactiveBranchConsumer may find instances of InactiveBranchPortObject in case the corresponding input is inactive.
• All nodes are allowed to return InactiveBranchPortObject elements in case the output should be inactivated.
• Loop end nodes may return null in case they restart the loop by setting the corresponding flags.

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.

createStreamableOperator

public StreamableOperator createStreamableOperator(PartitionInfo partitionInfo,
                                                   PortObjectSpec[] inSpecs)
                                            throws InvalidSettingsException

Streaming API (pending): Factory method for a streamable operator that is used to execute this node. The default implementation returns a standard operator that wraps the NodeModel.execute(PortObject[], ExecutionContext) method. Subclasses may override it to return a new operator that follows the data handling described by the NodeModel.getInputPortRoles() and NodeModel.getOutputPortRoles() methods.

This method is called by the node executor once or multiple times depending on the input roles. If any input is distributable, the method is called multiple times (for each partition once), possibly on different (remote) clones of this NodeModel.

Overrides:

createStreamableOperator in class NodeModel

Parameters:

partitionInfo - The partition info describing the chunk (if distributable).

inSpecs - The port object specs of the input ports. These are identical to the specs that NodeModel.configure(PortObjectSpec[]) was last called with (also on the remote side).

Returns:

A new operator for the (chunk) execution.

Throws:

InvalidSettingsException - Usually not thrown in the client but still part of the method signature as implementations often run the same methods as during configure. (This method is not being called when configure fails.)

getInputPortRoles

public InputPortRole[] getInputPortRoles()

Streaming API (pending): Defines properties on the input ports when used in a streamed and/or distributed fashion.

A data input is streamed when the node implementation only needs to see each data record once (no iterative access), otherwise it's non-streamed. If a port is streamed the StreamableOperator.runFinal(PortInput[], PortOutput[], ExecutionContext) method will provide the input as a RowInput object, to which the client implementation can safely type-cast to. For non-streamed ports the input is represented by an instance of PortObjectInput. Non-data ports (not BufferedDataTable) are always non-streamed.

An data input may be distributable (= parallelizable), in which case the data is processed in paralleled (possibly scattered in the cloud). Non-data ports are always non-distributable (but the execution may still take place in a distributed fashion if another port is distributed -- any non-distributable port is then simply duplicated as required).

Overrides:

getInputPortRoles in class NodeModel

Returns:

An array with the port role for each input port. Null elements are not allowed. The default implementation marks each input as InputPortRole.NONDISTRIBUTED_NONSTREAMABLE.

getOutputPortRoles

public OutputPortRole[] getOutputPortRoles()

Streaming API (pending): Similar to NodeModel.getInputPortRoles() describes the role of the output. An output is distributable when the (distributed!) input directly maps to the output without any further merge or reduction step (which is otherwise described by the NodeModel.createMergeOperator()). Only data outputs can be distributable, any other (model) output is always non-distributable. The input- and output roles define the place where the output data is generated:

• If the input data (and hence also the output data) is non-distributable, the output will be generated by the StreamableOperator.runFinal(PortInput[], PortOutput[], ExecutionContext) method. Only one instance of the operator is used.
• If both the input and output data is distributable the output is created by the StreamableOperator.runFinal(PortInput[], PortOutput[], ExecutionContext) method, too. Note that in this case there are several instances of a StreamableOperator (either representing different threads in the same JVM or distributed in a compute cluster).
• If the input is distributable but the output is non-distributable, the output is created in the NodeModel.finishStreamableExecution(StreamableOperatorInternals, ExecutionContext, PortOutput[]) implementation. The client implementation must also overwrite the NodeModel.createMergeOperator() method. The implementation of StreamableOperator.runFinal(PortInput[], PortOutput[], ExecutionContext) must not return or push any result into the PortOutput representations.

In case a node has "mixed" outputs (e.g. a distributable data output and a non-distributable model output) the output objects are produced at two different locations: The data in the StreamableOperator instances and the model after the merge in the NodeModel.

Overrides:

getOutputPortRoles in class NodeModel

Returns:

The output roles for each of the output ports, never null. The default implementation returns OutputPortRole.NONDISTRIBUTED.

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 unless this model is an InactiveBranchConsumer (most nodes are not). 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 (out spec not known at time of configuration) or inactive (output and downstream nodes are inactive).

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 data table specs. Items of the array could be null if no spec is available from the corresponding input port (i.e. not connected or upstream node does not produce an output spec). If a port is of type BufferedDataTable.TYPE and no spec is available the framework will replace null by an empty DataTableSpec (no columns) unless the port is marked as optional as per constructor.

Returns:

The output objects specs or null.

Throws:

InvalidSettingsException - If this node can't be configured.

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)

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)

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)

loadInternals

protected void loadInternals(File nodeInternDir,
                             ExecutionMonitor exec)

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.

See Also:

NodeModel.saveInternals(File,ExecutionMonitor)

saveInternals

protected void saveInternals(File nodeInternDir,
                             ExecutionMonitor exec)

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.

See Also:

NodeModel.loadInternals(File,ExecutionMonitor)