org.knime.core.data.container
Class JoinedTable

java.lang.Object
  org.knime.core.data.container.JoinedTable

All Implemented Interfaces:

Iterable<DataRow>, DataTable, BufferedDataTable.KnowsRowCountTable

public final class JoinedTable
extends Object
implements BufferedDataTable.KnowsRowCountTable

Class that realizes a join table of two BufferedDataTable arguments.

This class is not intended to be used in any node implementation, it is public only because some KNIME framework classes access it.

This class is used to represent the BufferedDataTable that is returned by the ExecutionContexts ExecutionContext.createJoinedTable( BufferedDataTable, BufferedDataTable, ExecutionMonitor) method.

Author:

Bernd Wiswedel, University of Konstanz

Method Summary

void	clear() Does nothing.
static JoinedTable	create(BufferedDataTable left, BufferedDataTable right, ExecutionMonitor prog) Creates new join table, does the sanity checks.
void	ensureOpen() Internal use.
DataTableSpec	getDataTableSpec() Returns the DataTableSpec object of this table which gives information about the structure of this data table.
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.
static JoinedTable	load(NodeSettingsRO s, DataTableSpec spec, Map<Integer,BufferedDataTable> tblRep) Method being called when the workflow is restored and the table shall recreated.
void	putIntoTableRepository(HashMap<Integer,ContainerTable> rep) Put this table into the global table repository.
boolean	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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDataTableSpec

public DataTableSpec getDataTableSpec()

Returns the DataTableSpec object of this table which gives information about the structure of this data table.

Specified by:

getDataTableSpec in interface DataTable

Returns:

the DataTableSpec of this table

iterator

public 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 Iterable<DataRow>

Specified by:

iterator in interface DataTable

Specified by:

iterator in interface BufferedDataTable.KnowsRowCountTable

Returns:

row iterator

See Also:

DataRow

clear

public void clear()

Does nothing. Clears any allocated temporary files. The table won't be used anymore.

Specified by:

clear in interface BufferedDataTable.KnowsRowCountTable

ensureOpen

public void ensureOpen()

Internal use. Implementation of BufferedDataTable.ensureOpen().

Specified by:

ensureOpen in interface BufferedDataTable.KnowsRowCountTable

getReferenceTables

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

Specified by:

getReferenceTables in interface BufferedDataTable.KnowsRowCountTable

Returns:

The reference table or null.

getRowCount

public int getRowCount()

Row count of the table.

Specified by:

getRowCount in interface BufferedDataTable.KnowsRowCountTable

Returns:

The row count.

putIntoTableRepository

public void putIntoTableRepository(HashMap<Integer,ContainerTable> rep)

Put this table into the global table repository. Called when execution finished.

Specified by:

putIntoTableRepository in interface BufferedDataTable.KnowsRowCountTable

Parameters:

rep - The workflow table repository.

removeFromTableRepository

public boolean removeFromTableRepository(HashMap<Integer,ContainerTable> rep)

Remove this table from global table repository. Called when node is reset.

Specified by:

removeFromTableRepository in interface BufferedDataTable.KnowsRowCountTable

Parameters:

rep - The workflow table repository.

Returns:

If this table was indeed removed from the table repository (true for ordinary container tables but false for wrappers such as concatenate or spec replacer)

saveToFile

public void saveToFile(File f,
                       NodeSettingsWO settings,
                       ExecutionMonitor exec)
                throws IOException,
                       CanceledExecutionException

Save the table to a file.

Specified by:

saveToFile in interface BufferedDataTable.KnowsRowCountTable

Parameters:

f - To write to.

settings - To add meta information to.

exec - For progress/cancel.

Throws:

IOException - If writing fails.

CanceledExecutionException - If canceled.

load

public static JoinedTable load(NodeSettingsRO s,
                               DataTableSpec spec,
                               Map<Integer,BufferedDataTable> tblRep)
                        throws InvalidSettingsException

Method being called when the workflow is restored and the table shall recreated.

Parameters:

s - The settings object, contains tables ids.

spec - The final spec.

tblRep - The table repository

Returns:

The restored table.

Throws:

InvalidSettingsException - If the settings can't be read.

create

public static JoinedTable create(BufferedDataTable left,
                                 BufferedDataTable right,
                                 ExecutionMonitor prog)
                          throws CanceledExecutionException

Creates new join table, does the sanity checks. Called from the ExecutionContext.createJoinedTable( BufferedDataTable, BufferedDataTable, ExecutionMonitor) method.

Parameters:

left - The left table.

right - The right table.

prog - For progress/cancel.

Returns:

A joined table.

Throws:

CanceledExecutionException - When canceled.

IllegalArgumentException - If row keys don't match or there are duplicate columns.