org.dbunit.dataset
Interface IDataSet

All Known Implementing Classes:
AbstractDataSet, CachedDataSet, CaseInsensitiveDataSet, CompositeDataSet, CsvDataSet, CsvURLDataSet, DatabaseDataSet, DefaultDataSet, FilteredDataSet, FlatDtdDataSet, FlatXmlDataSet, ForwardOnlyDataSet, LowerCaseDataSet, QueryDataSet, ReplacementDataSet, SortedDataSet, StreamingDataSet, XlsDataSet, XmlDataSet

public interface IDataSet

Represents a collection of tables.

Since:
Feb 17, 2002
Version:
$Revision: 398 $
Author:
Manuel Laflamme

Method Summary
 ITable getTable(java.lang.String tableName)
          Returns the specified table.
 ITableMetaData getTableMetaData(java.lang.String tableName)
          Returns the specified table metadata.
 java.lang.String[] getTableNames()
          Returns names of tables in this dataset in proper sequence.
 ITable[] getTables()
          Deprecated. Use iterator() or reverseIterator() instead.
 ITableIterator iterator()
          Returns an iterator over the tables in this dataset in proper sequence.
 ITableIterator reverseIterator()
          Returns an iterator over the tables in this dataset in reverse sequence.
 

Method Detail

getTableNames

java.lang.String[] getTableNames()
                                 throws DataSetException
Returns names of tables in this dataset in proper sequence. Multiple occurence of the same name may be returned if multiple tables having the same name are present in the dataset.

Throws:
DataSetException

getTableMetaData

ITableMetaData getTableMetaData(java.lang.String tableName)
                                throws DataSetException
Returns the specified table metadata.

Throws:
AmbiguousTableNameException - if dataset contains multiple tables having the specified name. Use iterator() to access to all tables.
NoSuchTableException - if dataset do not contains the specified table
DataSetException

getTable

ITable getTable(java.lang.String tableName)
                throws DataSetException
Returns the specified table.

Throws:
AmbiguousTableNameException - if dataset contains multiple tables having the specified name. Use iterator() to access to all tables.
NoSuchTableException - if dataset do not contains the specified table
DataSetException

getTables

ITable[] getTables()
                   throws DataSetException
Deprecated. Use iterator() or reverseIterator() instead.

Returns tables in this dataset in proper sequence. Multiple tables having the same name but different data may be returned.

Throws:
DataSetException

iterator

ITableIterator iterator()
                        throws DataSetException
Returns an iterator over the tables in this dataset in proper sequence.

Throws:
DataSetException

reverseIterator

ITableIterator reverseIterator()
                               throws DataSetException
Returns an iterator over the tables in this dataset in reverse sequence.

Throws:
DataSetException