org.knime.core.node
Interface BufferedDataTable.KnowsRowCountTable

All Superinterfaces:
DataTable, Iterable<DataRow>
All Known Implementing Classes:
ConcatenateTable, ContainerTable, JoinedTable, RearrangeColumnsTable, TableSpecReplacerTable, WrappedTable
Enclosing class:
BufferedDataTable

public static interface BufferedDataTable.KnowsRowCountTable
extends DataTable

Internally used interface. You won't have any benefit by implementing this interface! It's used for selected classes in the KNIME core.


Method Summary
 void clear()
          Clears any allocated temporary files.
 void ensureOpen()
          Implementation of BufferedDataTable.ensureOpen().
 BufferedDataTable[] getReferenceTables()
          Reference to the underlying tables, if any.
 int getRowCount()
          Row count of the table.
 CloseableRowIterator iterator()
          Overridden to narrow return type to closeable iterator.
 void putIntoTableRepository(HashMap<Integer,ContainerTable> rep)
          Put this table into the global table repository.
 void removeFromTableRepository(HashMap<Integer,ContainerTable> rep)
          Remove this table from global table repository.
 void saveToFile(File f, NodeSettingsWO settings, ExecutionMonitor exec)
          Save the table to a file.
 
Methods inherited from interface org.knime.core.data.DataTable
getDataTableSpec
 

Method Detail

getRowCount

int getRowCount()
Row count of the table.

Returns:
The row count.

saveToFile

void saveToFile(File f,
                NodeSettingsWO settings,
                ExecutionMonitor exec)
                throws IOException,
                       CanceledExecutionException
Save the table to a file.

Parameters:
f - To write to.
settings - To add meta information to.
exec - For progress/cancel.
Throws:
IOException - If writing fails.
CanceledExecutionException - If canceled.

clear

void clear()
Clears any allocated temporary files. The table won't be used anymore.


ensureOpen

void ensureOpen()
Implementation of BufferedDataTable.ensureOpen().


iterator

CloseableRowIterator iterator()
Overridden to narrow return type to closeable iterator. Returns a row iterator which returns each row one-by-one from the table.

Specified by:
iterator in interface DataTable
Specified by:
iterator in interface Iterable<DataRow>
Returns:
row iterator
See Also:
DataRow

getReferenceTables

BufferedDataTable[] getReferenceTables()
Reference to the underlying tables, if any. A reference table exists if this object is just a wrapper, such as a RearrangeColumnsTable or if this table concatenates a set of other tables.

Returns:
The reference table or null.

putIntoTableRepository

void putIntoTableRepository(HashMap<Integer,ContainerTable> rep)
Put this table into the global table repository. Called when execution finished.

Parameters:
rep - The workflow table repository.

removeFromTableRepository

void removeFromTableRepository(HashMap<Integer,ContainerTable> rep)
Remove this table from global table repository. Called when node is reset.

Parameters:
rep - The workflow table repository.


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.