org.knime.base.node.mine.bayes.naivebayes.port
Class NaiveBayesPortObject

java.lang.Object
  org.knime.core.node.port.AbstractSimplePortObject
      org.knime.base.node.mine.bayes.naivebayes.port.NaiveBayesPortObject

All Implemented Interfaces:

PortObject

public class NaiveBayesPortObject
extends AbstractSimplePortObject

The Naive Bayes specific port object implementation.

Author:

Tobias Koetter, University of Konstanz

Nested Class Summary

Nested classes/interfaces inherited from interface org.knime.core.node.port.PortObject

PortObject.PortObjectSerializer<T extends PortObject>

Field Summary

static PortType

TYPE The PortType.

Constructor Summary

NaiveBayesPortObject()
Constructor for class NaiveBayesPortObject.

NaiveBayesPortObject(DataTableSpec trainingDataSpec, NaiveBayesModel model)
Constructor for class NaiveBayesPortObject.

Method Summary

NaiveBayesModel	getModel()
PortObjectSpec	getSpec() Get specification to this port object.
String	getSummary() Get a short summary of this PortObject.
protected void	load(ModelContentRO model, PortObjectSpec spec, ExecutionMonitor exec) Loads the content into the freshly instantiated object.
protected void	save(ModelContentWO model, ExecutionMonitor exec) Saves this object to model content object.

Methods inherited from class org.knime.core.node.port.AbstractSimplePortObject

equals, getPortObjectSerializer, getViews, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final PortType TYPE

The PortType.

Constructor Detail

NaiveBayesPortObject

public NaiveBayesPortObject()

Constructor for class NaiveBayesPortObject.

NaiveBayesPortObject

public NaiveBayesPortObject(DataTableSpec trainingDataSpec,
                            NaiveBayesModel model)

Constructor for class NaiveBayesPortObject.

Parameters:

trainingDataSpec - the DataTableSpec of the training table

model - the NaiveBayesModel

Method Detail

load

protected void load(ModelContentRO model,
                    PortObjectSpec spec,
                    ExecutionMonitor exec)
             throws InvalidSettingsException

Loads the content into the freshly instantiated object. This method is called at most once in the life time of the object (after the serializer has created a new object using the public no-arg constructor.)

Specified by:

load in class AbstractSimplePortObject

Parameters:

model - To load from.

spec - The accompanying spec (which can be safely cast to the expected class).

exec - For progress/cancelation.

Throws:

InvalidSettingsException - If settings are incomplete/deficient.

save

protected void save(ModelContentWO model,
                    ExecutionMonitor exec)

Saves this object to model content object.

Specified by:

save in class AbstractSimplePortObject

Parameters:

model - To save to.

exec - For progress/cancelation.

getSpec

public PortObjectSpec getSpec()

Get specification to this port object. That is, the corresponding PortObjectSpec which is used to configure any successor node after execution, e.g. a BufferedDataTable can return a DataTableSpec.

Subclasses should narrow the return type if possible.

Returns:

underlying PortObjectSpec or any derived spec, never null.

getSummary

public String getSummary()

Get a short summary of this PortObject. The return value will be shown in a node port's tooltip, for instance.

Returns:

Summary of the object's content, suitable for a tooltip. Empty strings and null result values are ok (though not encouraged).

getModel

public NaiveBayesModel getModel()

Returns:

the NaiveBayesModel