Package org.dbunit.dataset

Class FilteredDataSet

java.lang.Object

org.dbunit.dataset.AbstractDataSet

org.dbunit.dataset.FilteredDataSet

All Implemented Interfaces:

IDataSet

public class FilteredDataSet
extends AbstractDataSet

Decorates a dataset and exposes only some tables from it. Can be used with different filtering strategies.

Since:

Feb 22, 2002

Version:

$Revision$

Author:

Manuel Laflamme, Last changed by: Luke Cann

See Also:

• ITableFilter
• SequenceTableFilter
• DefaultTableFilter

Field Summary

Fields inherited from class org.dbunit.dataset.AbstractDataSet

_orderedTableNameMap

Constructor Summary

Constructors

Constructor	Description
FilteredDataSet(String[] tableNames, IDataSet dataSet)	Creates a FilteredDataSet that decorates the specified dataset and exposes only the specified tables using SequenceTableFilter as filtering strategy.
FilteredDataSet(ITableFilter filter, IDataSet dataSet)	Creates a FilteredDataSet that decorates the specified dataset and exposes only the tables allowed by the specified filter.

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

FilteredDataSet

public FilteredDataSet(String[] tableNames,
 IDataSet dataSet)
                throws AmbiguousTableNameException

Creates a FilteredDataSet that decorates the specified dataset and exposes only the specified tables using SequenceTableFilter as filtering strategy.

Parameters:

tableNames - the names of the tables to expose, in the order they should be exposed.

dataSet - the dataset to decorate.

Throws:

AmbiguousTableNameException - If the given tableNames array contains ambiguous names

FilteredDataSet

public FilteredDataSet(ITableFilter filter,
 IDataSet dataSet)

Creates a FilteredDataSet that decorates the specified dataset and exposes only the tables allowed by the specified filter.

Parameters:

filter - the filtering strategy

dataSet - the filtered dataset

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