Package org.dbunit.database

Class DatabaseDataSet

java.lang.Object

org.dbunit.dataset.AbstractDataSet

org.dbunit.database.DatabaseDataSet

All Implemented Interfaces:

IDataSet

public class DatabaseDataSet
extends AbstractDataSet

Provides access to a database instance as a IDataSet.

Since:

1.0 (Feb 17, 2002)

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
DatabaseDataSet(IDatabaseConnection connection, boolean caseSensitiveTableNames)	Creates a new database data set
DatabaseDataSet(IDatabaseConnection connection, boolean caseSensitiveTableNames, ITableFilterSimple tableFilter)	Creates a new database data set

Method Summary

Modifier and Type	Method	Description
protected ITableIterator	createIterator(boolean reversed)	Creates an iterator which provides access to all tables of this dataset
ITable	getTable(String tableName)	Returns the specified table.
ITableMetaData	getTableMetaData(String tableName)	Returns the specified table metadata.
String[]	getTableNames()	Returns names of tables in this dataset in proper sequence.

Methods inherited from class org.dbunit.dataset.AbstractDataSet

createTableNameMap, 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

DatabaseDataSet

public DatabaseDataSet(IDatabaseConnection connection,
 boolean caseSensitiveTableNames)
                throws SQLException

Creates a new database data set

Parameters:

connection - The database connection

caseSensitiveTableNames - Whether or not this dataset should use case sensitive table names

Throws:

SQLException - if retrieving the database metadata fails.

Since:

2.4

DatabaseDataSet

public DatabaseDataSet(IDatabaseConnection connection,
 boolean caseSensitiveTableNames,
 ITableFilterSimple tableFilter)
                throws SQLException

Creates a new database data set

Parameters:

connection - The database connection

caseSensitiveTableNames - Whether or not this dataset should use case sensitive table names

tableFilter - Table filter to specify tables to be omitted in this dataset. Can be null.

Throws:

SQLException - if retrieving the database metadata fails.

Since:

2.4.3

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.

getTableNames

public String[] getTableNames()
                       throws DataSetException

Description copied from interface: IDataSet

Returns names of tables in this dataset in proper sequence. Multiple occurrence of the same name may be returned if multiple tables having the same name are present in the dataset.

Specified by:

getTableNames in interface IDataSet

Overrides:

getTableNames in class AbstractDataSet

Returns:

the table names, in proper sequence.

Throws:

DataSetException - if the table names cannot be determined.

getTableMetaData

public ITableMetaData getTableMetaData(String tableName)
                                throws DataSetException

Description copied from interface: IDataSet

Returns the specified table metadata.

Specified by:

getTableMetaData in interface IDataSet

Overrides:

getTableMetaData in class AbstractDataSet

Parameters:

tableName - the name of the table to look up.

Returns:

the metadata of the specified table.

Throws:

DataSetException

getTable

public ITable getTable(String tableName)
                throws DataSetException

Description copied from interface: IDataSet

Returns the specified table.

Specified by:

getTable in interface IDataSet

Overrides:

getTable in class AbstractDataSet

Parameters:

tableName - the name of the table to look up.

Returns:

the specified table.

Throws:

DataSetException