Package org.dbunit.dataset

Interface IDataSet

All Known Implementing Classes:
AbstractDataSet, CachedDataSet, CaseInsensitiveDataSet, CompositeDataSet, CsvDataSet, CsvURLDataSet, DatabaseDataSet, DefaultDataSet, FilteredDataSet, FlatDtdDataSet, FlatXmlDataSet, ForwardOnlyDataSet, JsonDataSet, LowerCaseDataSet, QueryDataSet, ReplacementDataSet, SortedDataSet, SqlLoaderControlDataSet, StreamingDataSet, TableDecoratorDataSet, XlsDataSet, XmlDataSet, YamlDataSet
public interface IDataSet
Represents a collection of tables.
Since:
Feb 17, 2002
Version:
$Revision$
Author:
Manuel Laflamme

  • Method Details

    • getTableNames

      String[] getTableNames() throws DataSetException
      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.
      Returns:
      the table names, in proper sequence.
      Throws:
      DataSetException - if the table names cannot be determined.

    • getTableMetaData

      ITableMetaData getTableMetaData(String tableName) throws DataSetException
      Returns the specified table metadata.
      Parameters:
      tableName - the name of the table to look up.
      Returns:
      the metadata of 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

    • getTable

      ITable getTable(String tableName) throws DataSetException
      Returns the specified table.
      Parameters:
      tableName - the name of the table to look up.
      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.
      Returns:
      the tables in this dataset, in proper sequence.
      Throws:
      DataSetException - if the tables cannot be determined.

    • iterator

      ITableIterator iterator() throws DataSetException
      Returns an iterator over the tables in this dataset in proper sequence.
      Returns:
      an iterator over the tables in this dataset.
      Throws:
      DataSetException - if the iterator cannot be created.

    • reverseIterator

      ITableIterator reverseIterator() throws DataSetException
      Returns an iterator over the tables in this dataset in reverse sequence.
      Returns:
      an iterator over the tables in this dataset, in reverse sequence.
      Throws:
      DataSetException - if the iterator cannot be created.

    • isCaseSensitiveTableNames

      boolean isCaseSensitiveTableNames()
      Whether or not this dataset handles table names in a case sensitive way or not.
      Returns:
      true if the case sensitivity of table names is used in this dataset.
      Since:
      2.4.2