Package org.dbunit.dataset

Class CachedDataSet

java.lang.Object

org.dbunit.dataset.AbstractDataSet

org.dbunit.dataset.CachedDataSet

All Implemented Interfaces:

IDataSet, IDataSetConsumer

Direct Known Subclasses:

CsvDataSet, CsvURLDataSet, FlatXmlDataSet, JsonDataSet, SqlLoaderControlDataSet, XmlDataSet, YamlDataSet

public class CachedDataSet
extends AbstractDataSet
implements IDataSetConsumer

Hold copy of another dataset or a consumed provider content.

Since:

1.x (Apr 18, 2003)

Version:

$Revision$ $Date$

Author:

Manuel Laflamme, Last changed by: $Author$

Field Summary

Fields inherited from class org.dbunit.dataset.AbstractDataSet

_orderedTableNameMap

Constructor Summary

Constructors

Constructor	Description
CachedDataSet()	Default constructor.
CachedDataSet(IDataSet dataSet)	Creates a copy of the specified dataset.
CachedDataSet(IDataSetProducer producer)	Creates a CachedDataSet that synchronously consume the specified producer.
CachedDataSet(IDataSetProducer producer, boolean caseSensitiveTableNames)	Creates a CachedDataSet that synchronously consume the specified producer.

Method Summary

Modifier and Type	Method	Description
protected ITableIterator	createIterator(boolean reversed)	Creates an iterator which provides access to all tables of this dataset
void	endDataSet()	Receive notification of the end of a dataset.
void	endTable()	Receive notification of the end of a table.
void	row(Object[] values)	Receive notification of a table row.
void	startDataSet()	Receive notification of the beginning of a dataset.
void	startTable(ITableMetaData metaData)	Receive notification of the beginning of a table.

Methods inherited from class org.dbunit.dataset.AbstractDataSet

createTableNameMap, getTable, getTableMetaData, getTableNames, getTables, initialize, isCaseSensitiveTableNames, iterator, reverseIterator, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CachedDataSet

public CachedDataSet()
              throws DataSetException

Default constructor.

Throws:

DataSetException - if initialization fails.

CachedDataSet

public CachedDataSet(IDataSet dataSet)
              throws DataSetException

Creates a copy of the specified dataset.

Parameters:

dataSet - the dataset to copy.

Throws:

DataSetException - if copying the dataset fails.

CachedDataSet

public CachedDataSet(IDataSetProducer producer)
              throws DataSetException

Creates a CachedDataSet that synchronously consume the specified producer.

Parameters:

producer - the producer to consume.

Throws:

DataSetException - if consuming the producer fails.

CachedDataSet

public CachedDataSet(IDataSetProducer producer,
 boolean caseSensitiveTableNames)
              throws DataSetException

Creates a CachedDataSet that synchronously consume the specified producer.

Parameters:

producer - the producer to consume.

caseSensitiveTableNames - Whether or not case sensitive table names should be used

Throws:

DataSetException - if consuming the producer fails.

Method Details

createIterator

protected ITableIterator createIterator(boolean reversed)
                                 throws DataSetException

Description copied from class: AbstractDataSet

Creates an iterator which provides access to all tables of this dataset

Specified by:

createIterator in class AbstractDataSet

Parameters:

reversed - Whether the created iterator should be a reversed one or not

Returns:

The created ITableIterator

Throws:

DataSetException - if the iterator cannot be created.

startDataSet

public void startDataSet()
                  throws DataSetException

Description copied from interface: IDataSetConsumer

Receive notification of the beginning of a dataset. This method is invoked only once, before any other methods in this interface.

Specified by:

startDataSet in interface IDataSetConsumer

Throws:

DataSetException - if the notification cannot be processed.

endDataSet

public void endDataSet()
                throws DataSetException

Description copied from interface: IDataSetConsumer

Receive notification of the end of a dataset. This method is invoked only once, and it will be the last method invoked in this interface.

Specified by:

endDataSet in interface IDataSetConsumer

Throws:

DataSetException - if the notification cannot be processed.

startTable

public void startTable(ITableMetaData metaData)
                throws DataSetException

Description copied from interface: IDataSetConsumer

Receive notification of the beginning of a table. This method is invoked at the beginning of every table in the dataset; there will be a corresponding IDataSetConsumer.endDataSet() event for every startTable event (even when the table is empty).

Specified by:

startTable in interface IDataSetConsumer

Parameters:

metaData - the table metadata

Throws:

DataSetException - if the notification cannot be processed.

endTable

public void endTable()
              throws DataSetException

Description copied from interface: IDataSetConsumer

Receive notification of the end of a table.

Specified by:

endTable in interface IDataSetConsumer

Throws:

DataSetException - if the notification cannot be processed.

row

public void row(Object[] values)
         throws DataSetException

Description copied from interface: IDataSetConsumer

Receive notification of a table row. This method is invoked to report each row of a table.

Specified by:

row in interface IDataSetConsumer

Parameters:

values - The row values.

Throws:

DataSetException - if the notification cannot be processed.