org.knime.core.data.container
Class AbstractCellFactory

java.lang.Object
  extended by org.knime.core.data.container.AbstractCellFactory
All Implemented Interfaces:
CellFactory
Direct Known Subclasses:
SingleCellFactory

public abstract class AbstractCellFactory
extends Object
implements CellFactory

Default implementation of a CellFactory, which creates more than a single new column.

Author:
Bernd Wiswedel, University of Konstanz
See Also:
SingleCellFactory

Constructor Summary
AbstractCellFactory(DataColumnSpec... colSpecs)
          Creates instance, which will produce content for the columns as specified by the array argument.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.knime.core.data.container.CellFactory
getCells
 

Constructor Detail

AbstractCellFactory

public AbstractCellFactory(DataColumnSpec... colSpecs)
Creates instance, which will produce content for the columns as specified by the array argument.

Parameters:
colSpecs - The specs of the columns being created.
Method Detail

getColumnSpecs

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

Specified by:
getColumnSpecs in interface CellFactory
Returns:
The specs to the newly created cells.

setProgress

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

Specified by:
setProgress in interface CellFactory
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.


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.