Package org.dbunit.database

Class DatabaseTableMetaData

java.lang.Object

org.dbunit.dataset.AbstractTableMetaData

org.dbunit.database.DatabaseTableMetaData

All Implemented Interfaces:

ITableMetaData

public class DatabaseTableMetaData
extends AbstractTableMetaData

Container for the metadata for one database table. The metadata is initialized using a IDatabaseConnection.

Since:

Mar 8, 2002

Version:

$Revision$ $Date$

Author:

Manuel Laflamme, Last changed by: $Author$

See Also:

• ITableMetaData

Method Summary

Modifier and Type	Method	Description
static ITableMetaData	createMetaData(String tableName, ResultSet resultSet, IDatabaseConnection connection)	Deprecated. since 2.3.0. use ResultSetTableMetaData(String, ResultSet, IDatabaseConnection, boolean)
static ITableMetaData	createMetaData(String tableName, ResultSet resultSet, IDataTypeFactory dataTypeFactory)	Deprecated. since 2.3.0. use ResultSetTableMetaData(String, ResultSet, IDataTypeFactory, boolean)
Column[]	getColumns()	Returns this table columns as recognized by dbunit.
Column[]	getPrimaryKeys()	Returns this table primary key columns.
String	getTableName()	Returns this table name.
String	toString()

Methods inherited from class org.dbunit.dataset.AbstractTableMetaData

getColumnIndex, getDataTypeFactory, getPrimaryKeys, getPrimaryKeys

Methods inherited from class java.lang.Object

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

Method Details

createMetaData

public static ITableMetaData createMetaData(String tableName,
 ResultSet resultSet,
 IDataTypeFactory dataTypeFactory)
                                     throws DataSetException,
SQLException

Deprecated.

since 2.3.0. use ResultSetTableMetaData(String, ResultSet, IDataTypeFactory, boolean)

Parameters:

tableName -

resultSet -

dataTypeFactory -

Returns:

The table metadata created for the given parameters

Throws:

DataSetException

SQLException

createMetaData

public static ITableMetaData createMetaData(String tableName,
 ResultSet resultSet,
 IDatabaseConnection connection)
                                     throws SQLException,
DataSetException

Deprecated.

since 2.3.0. use ResultSetTableMetaData(String, ResultSet, IDatabaseConnection, boolean)

Parameters:

tableName -

resultSet -

connection -

Returns:

The table metadata created for the given parameters

Throws:

SQLException

DataSetException

getTableName

public String getTableName()

Description copied from interface: ITableMetaData

Returns this table name.

Returns:

this table name

getColumns

public Column[] getColumns()
                    throws DataSetException

Description copied from interface: ITableMetaData

Returns this table columns as recognized by dbunit. In cases where columns are resolved using database metadata it can happen that an empty array is returned when a table does not have a single column that is recognized by the configured IDataTypeFactory. Note that it is not an exceptional case within dbunit when a ITableMetaData does not have a column.

Returns:

The columns for this table

Throws:

DataSetException

getPrimaryKeys

public Column[] getPrimaryKeys()
                        throws DataSetException

Description copied from interface: ITableMetaData

Returns this table primary key columns.

Returns:

this table primary key columns.

Throws:

DataSetException

toString

public String toString()

Overrides:

toString in class Object