Package org.dbunit.ext.db2

Class Db2MetadataHandler

java.lang.Object

org.dbunit.database.DefaultMetadataHandler

org.dbunit.ext.db2.Db2MetadataHandler

All Implemented Interfaces:

IMetadataHandler

public class Db2MetadataHandler
extends DefaultMetadataHandler

Customized MetadataHandler for DB2 as match Columns of DefaultMetadataHandler fails with a RuntimeException.

Since:

2.4.7

Version:

$Revision$ $Date$

Author:

gommma (gommma AT users.sourceforge.net), Last changed by: $Author$

Constructor Summary

Constructors

Constructor	Description
Db2MetadataHandler()	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	matches(ResultSet columnsResultSet, String catalog, String schema, String table, String column, boolean caseSensitive)	This method is overridden since - at least with DB2 driver db2jcc-9.5.jar - there is a problem that the DatabaseMetaData does not return the same values for catalog and schema like the columns ResultSet does.
boolean	matchesColumn(String searchCatalog, String actualCatalog, String searchSchema, String actualSchema, String searchTable, String actualTable, String searchColumn, String actualColumn, boolean caseSensitive)	Tests whether a candidate column's metadata values match the search criteria, using the same semantics as IMetadataHandler.matches(ResultSet, String, String, String, String, boolean) but operating on already-extracted values instead of a live ResultSet row.
boolean	supportsColumnCache()	Whether ResultSetTableMetaData's per-table column-metadata cache may safely use IMetadataHandler.matchesColumn(String, String, String, String, String, String, String, String, boolean) in place of the row-by-row IMetadataHandler.matches(ResultSet, String, String, String, String, boolean) scan for this handler.

Methods inherited from class org.dbunit.database.DefaultMetadataHandler

getColumns, getPrimaryKeys, getSchema, getTables, matches, tableExists

Methods inherited from class java.lang.Object

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

Constructor Details

Db2MetadataHandler

public Db2MetadataHandler()

Default constructor.

Method Details

matches

public boolean matches(ResultSet columnsResultSet,
 String catalog,
 String schema,
 String table,
 String column,
 boolean caseSensitive)
                throws SQLException

This method is overridden since - at least with DB2 driver db2jcc-9.5.jar - there is a problem that the DatabaseMetaData does not return the same values for catalog and schema like the columns ResultSet does. The debugging constellation is as follows

 catalog="BLA", catalogName=<null>
 schema="BLA", schemaName="BLA"
 

This problem is taken into account by this metadata handler. Checks if the given resultSet matches the given schema and table name. The comparison is case sensitive.

Specified by:

matches in interface IMetadataHandler

Overrides:

matches in class DefaultMetadataHandler

Parameters:

columnsResultSet - A result set produced via DatabaseMetaData.getColumns(String, String, String, String)

catalog - The name of the catalog to check. If null it is ignored in the comparison

schema - The name of the schema to check. If null it is ignored in the comparison

table - The name of the table to check. If null it is ignored in the comparison

column - The name of the column to check. If null it is ignored in the comparison

caseSensitive - Whether or not the comparison should be case sensitive

Returns:

true if the column metadata of the given resultSet matches the given schema and table parameters.

Throws:

SQLException - if a database access error occurs.

See Also:

• DefaultMetadataHandler.matches(java.sql.ResultSet, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)

matchesColumn

public boolean matchesColumn(String searchCatalog,
 String actualCatalog,
 String searchSchema,
 String actualSchema,
 String searchTable,
 String actualTable,
 String searchColumn,
 String actualColumn,
 boolean caseSensitive)

Tests whether a candidate column's metadata values match the search criteria, using the same semantics as IMetadataHandler.matches(ResultSet, String, String, String, String, boolean) but operating on already-extracted values instead of a live ResultSet row. This lets a caller that batch-fetches and caches DatabaseMetaData#getColumns rows (see ResultSetTableMetaData) replay this handler's matching rules against a cached row without re-querying or holding a ResultSet open.

The default implementation mirrors DefaultMetadataHandler's matching rules. A handler whose IMetadataHandler.matches(ResultSet, String, String, String, String, boolean) override differs must override this method the same way, and override IMetadataHandler.supportsColumnCache() to return true. Mirrors matches(ResultSet, String, String, String, String, boolean)'s catalog-mismatch tolerance, using areEqualIgnoreBothNull(String, String, boolean) for the catalog comparison instead of the inherited default's SQLHelper.areEqualIgnoreNull(String, String, boolean).

Parameters:

searchCatalog - The catalog to search for. If null or empty it is ignored in the comparison.

actualCatalog - The candidate row's catalog.

searchSchema - The schema to search for. If null or empty it is ignored in the comparison.

actualSchema - The candidate row's schema.

searchTable - The table to search for. If null or empty it is ignored in the comparison.

actualTable - The candidate row's table.

searchColumn - The column to search for. If null or empty it is ignored in the comparison.

actualColumn - The candidate row's column.

caseSensitive - Whether or not the comparison should be case sensitive.

Returns:

true if the candidate's values match the search criteria.

supportsColumnCache

public boolean supportsColumnCache()

Whether ResultSetTableMetaData's per-table column-metadata cache may safely use IMetadataHandler.matchesColumn(String, String, String, String, String, String, String, String, boolean) in place of the row-by-row IMetadataHandler.matches(ResultSet, String, String, String, String, boolean) scan for this handler.

Returns false by default, so a custom IMetadataHandler whose matches(...) override is not also replicated in matchesColumn(...) keeps the legacy per-column behavior. Override to return true only alongside a matchesColumn(...) override that fully replicates this handler's matching semantics. The inherited default matchesColumn(...) already mirrors this class's DefaultMetadataHandler.matches(ResultSet, String, String, String, String, boolean), so the cache fast path is safe to use.

Specified by:

supportsColumnCache in interface IMetadataHandler

Overrides:

supportsColumnCache in class DefaultMetadataHandler

Returns:

true, since matchesColumn(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) replicates this class's matches(ResultSet, String, String, String, String, boolean) semantics.