org.knime.base.data.normalize
Class NormalizerPortObject

java.lang.Object
  org.knime.core.node.port.AbstractSimplePortObject
      org.knime.base.data.normalize.NormalizerPortObject

All Implemented Interfaces:

PortObject

public final class NormalizerPortObject
extends AbstractSimplePortObject

Port Object that is passed along a normalizer and a normalizer apply node.

This class is not official API, it may change without prior notice.

Author:

Bernd Wiswedel, 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 Convenience accessor for the port type.

Constructor Summary

NormalizerPortObject()
Empty constructor required by super class, should not be used.

NormalizerPortObject(DataTableSpec spec, AffineTransConfiguration configuration)
Create new port object given the arguments.

Method Summary

AffineTransConfiguration	getConfiguration()
DataTableSpec	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

Convenience accessor for the port type.

Constructor Detail

NormalizerPortObject

public NormalizerPortObject()

Empty constructor required by super class, should not be used.

NormalizerPortObject

public NormalizerPortObject(DataTableSpec spec,
                            AffineTransConfiguration configuration)

Create new port object given the arguments.

Parameters:

spec - Spec of this port object (contains columns to be normalized).

configuration - The normalization configuration.

Throws:

NullPointerException - If either arg is null

IllegalArgumentException - If columns to be normalized don't exist or are not numeric.

Method Detail

getSpec

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

getConfiguration

public AffineTransConfiguration getConfiguration()

Returns:

the configuration

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.