org.knime.core.data.container
Interface CellFactory

All Known Implementing Classes:

AbstractCellFactory, AbstractMany2OneCellFactory, BasisFunctionPredictorCellFactory, BinaryCellFactory, BinnerColumnFactory, BinnerColumnFactory, BinningCellFactory, BitString2BitVectorCellFactory, BitVectorCellFactory, BitVectorColumnCellFactory, CategoryToNumberApplyCellFactory, CategoryToNumberCellFactory, CellSplitterByPosCellFactory, CellSplitterCellFactory, ClusterMembershipFactory, Hex2BitVectorCellFactory, IdString2BitVectorCellFactory, LogRegPredictor, MDSCellFactory, MinMaxCellFactory, NaiveBayesCellFactory, Numeric2BitVectorMeanCellFactory, Numeric2BitVectorThresholdCellFactory, One2ManyCellFactory, RegExpCellFactory, SingleCellFactory, SotaPredictorCellFactory, SVMPredictor

public interface CellFactory

Factory for a ColumnRearranger to provide new columns which are, e.g. appended to a given table.

Note, it's strongly recommend to extend the abstract classes AbstractCellFactory and SingleCellFactory instead of implementing this interface. These classes also enable the parallel processing of the input table.

Author:

Bernd Wiswedel, University of Konstanz

See Also:

ColumnRearranger, ColumnRearranger.append(CellFactory)

Method Summary

DataCell[]	getCells(DataRow row) Get the new cells for a given row.
DataColumnSpec[]	getColumnSpecs() The column specs for the cells that are generated in the getCells() method.
void	setProgress(int curRowNr, int rowCount, RowKey lastKey, ExecutionMonitor exec) This method is called when a row has been processed.

Method Detail

getCells

DataCell[] getCells(DataRow row)

Get the new cells for a given row. These cells are incorporated into the existing row. The way it is done is defined through the ColumnRearranger using this object.

Parameters:

row - The row of interest.

Returns:

The new cells to that row.

Throws:

IllegalArgumentException - If there is no mapping available.

getColumnSpecs

DataColumnSpec[] getColumnSpecs()

The column specs for the cells that are generated in the getCells() method. This method is only called once, there is no need to cache the return value. The length of the returned array must match the length of the array returned by the getCells(DataRow) method and also the types must match, i.e. the type of the respective DataColumnSpec must be of the same type or a super type of the cell as returned by getCells(DataRow).

Returns:

The specs to the newly created cells.

setProgress

void setProgress(int curRowNr,
                 int rowCount,
                 RowKey lastKey,
                 ExecutionMonitor exec)

This method is called when a row has been processed. It allows the implementor to set progress in the execution monitor and also some meaningful progress message.

Note, you don't need to check exec.checkCanceled() in the implementation as this is done in the calling class.

Parameters:

curRowNr - The number of the row just processed

rowCount - The total number of rows.

lastKey - The row's key.

exec - The execution monitor to report progress to.