org.knime.base.node.mine.sota
Class SotaPortObject

java.lang.Object
  org.knime.core.node.port.AbstractSimplePortObject
      org.knime.base.node.mine.sota.SotaPortObject

All Implemented Interfaces:

PortObject

public class SotaPortObject
extends AbstractSimplePortObject

Author:

Kilian Thiel, 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

(package private) static String	CFG_KEY_CLASSCOL_INDEX The configuration key for the index of the class column.
(package private) static String	CFG_KEY_DIST The configuration key for the distance to use.
(package private) static String	CFG_KEY_INDATA_SIZE The configuration key for the size of the in data container.
(package private) static String	CFG_KEY_MAX_FUZZY_LEVEL The configuration key for the maximal fuzzy hierarchy level.
(package private) static String	CFG_KEY_ORIGDATA_SIZE The configuration key for the size of the original data container.
(package private) static String	CFG_KEY_SPEC The configuration key for the object spec.
(package private) static String	CFG_KEY_USE_FUZZY_HIERARCHY The configuration key for the usage of hierarchical fuzzy data.

Constructor Summary

SotaPortObject()
Creates empty instance of SotaPortObject.

SotaPortObject(SotaManager sota, DataTableSpec spec, int indexOfClassCol)
Creates new instance of SotaPortObject with given SotaManager, DataTableSpec and index of the class column to store.

Method Summary

String	getDistance()
SotaManager	getSota()
SotaTreeCell	getSotaRoot()
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.
void	setSota(SotaManager sota) Sets the given SotaManager.

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

CFG_KEY_USE_FUZZY_HIERARCHY

static final String CFG_KEY_USE_FUZZY_HIERARCHY

The configuration key for the usage of hierarchical fuzzy data.

See Also:

Constant Field Values

CFG_KEY_MAX_FUZZY_LEVEL

static final String CFG_KEY_MAX_FUZZY_LEVEL

The configuration key for the maximal fuzzy hierarchy level.

See Also:

Constant Field Values

CFG_KEY_INDATA_SIZE

static final String CFG_KEY_INDATA_SIZE

The configuration key for the size of the in data container.

See Also:

Constant Field Values

CFG_KEY_ORIGDATA_SIZE

static final String CFG_KEY_ORIGDATA_SIZE

The configuration key for the size of the original data container.

See Also:

Constant Field Values

CFG_KEY_DIST

static final String CFG_KEY_DIST

The configuration key for the distance to use.

See Also:

Constant Field Values

CFG_KEY_SPEC

static final String CFG_KEY_SPEC

The configuration key for the object spec.

See Also:

Constant Field Values

CFG_KEY_CLASSCOL_INDEX

static final String CFG_KEY_CLASSCOL_INDEX

The configuration key for the index of the class column.

See Also:

Constant Field Values

Constructor Detail

SotaPortObject

public SotaPortObject()

Creates empty instance of SotaPortObject.

SotaPortObject

public SotaPortObject(SotaManager sota,
                      DataTableSpec spec,
                      int indexOfClassCol)

Creates new instance of SotaPortObject with given SotaManager, DataTableSpec and index of the class column to store.

Parameters:

sota - The SotaManager to store.

spec - The data table spec to store.

indexOfClassCol - The index of the class column.

Method Detail

load

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

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.

CanceledExecutionException - If canceled.

save

protected void save(ModelContentWO model,
                    ExecutionMonitor exec)
             throws CanceledExecutionException

Saves this object to model content object.

Specified by:

save in class AbstractSimplePortObject

Parameters:

model - To save to.

exec - For progress/cancelation.

Throws:

CanceledExecutionException - If canceled.

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).

setSota

public void setSota(SotaManager sota)

Sets the given SotaManager.

Parameters:

sota - The SotaManager to set.

getSota

public SotaManager getSota()

Returns:

the sota

getSotaRoot

public SotaTreeCell getSotaRoot()

Returns:

the sotaRoot

getDistance

public String getDistance()

Returns:

the distance