Package org.dbunit.ext.mysql

Class MySqlMetadataHandler

java.lang.Object

org.dbunit.ext.mysql.MySqlMetadataHandler

All Implemented Interfaces:

IMetadataHandler

Direct Known Subclasses:

MultiSchemaMySqlMetadataHandler

public class MySqlMetadataHandler
extends Object
implements IMetadataHandler

Special metadata handler for MySQL.
Was introduced to fix "[ 2545095 ] Mysql FEATURE_QUALIFIED_TABLE_NAMES column SQLHelper.matches".

Since:

2.4.4

Version:

$Revision$ $Date$

Author:

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

Constructor Summary

Constructors

Constructor	Description
MySqlMetadataHandler()

Method Summary

Modifier and Type	Method	Description
ResultSet	getColumns(DatabaseMetaData databaseMetaData, String schemaName, String tableName)	Returns the result set for an invocation of DatabaseMetaData.getColumns(String, String, String, String).
ResultSet	getPrimaryKeys(DatabaseMetaData metaData, String schemaName, String tableName)	Returns the primary keys of the given table.
String	getSchema(ResultSet resultSet)	Returns the schema name to which the table of the current result set index belongs.
ResultSet	getTables(DatabaseMetaData metaData, String schemaName, String[] tableType)	Returns the tables in the given schema that matches one of the given tableTypes.
boolean	matches(ResultSet resultSet, String schema, String table, boolean caseSensitive)	Checks if the given resultSet matches the given schema and table name.
boolean	matches(ResultSet columnsResultSet, String catalog, String schema, String table, String column, boolean caseSensitive)	Checks if the given resultSet matches the given schema and table name.
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.
boolean	tableExists(DatabaseMetaData metaData, String schema, String tableName)	Checks if the given table exists.

Methods inherited from class java.lang.Object

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

Constructor Details

MySqlMetadataHandler

public MySqlMetadataHandler()

Method Details

getColumns

public ResultSet getColumns(DatabaseMetaData databaseMetaData,
 String schemaName,
 String tableName)
                     throws SQLException

Description copied from interface: IMetadataHandler

Returns the result set for an invocation of DatabaseMetaData.getColumns(String, String, String, String).

Specified by:

getColumns in interface IMetadataHandler

Parameters:

databaseMetaData - The database metadata to be used for retrieving the columns

schemaName - The schema name

tableName - The table name

Returns:

The result set containing all columns

Throws:

SQLException - if a database access error occurs.

matches

public boolean matches(ResultSet resultSet,
 String schema,
 String table,
 boolean caseSensitive)
                throws SQLException

Description copied from interface: IMetadataHandler

Checks if the given resultSet matches the given schema and table name. The comparison is case sensitive.

Specified by:

matches in interface IMetadataHandler

Parameters:

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

schema - the schema name to check.

table - the table name to check.

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:

• IMetadataHandler.matches(ResultSet, String, String, String, String, boolean)

matches

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

Description copied from interface: IMetadataHandler

Checks if the given resultSet matches the given schema and table name. The comparison is case sensitive.

Specified by:

matches in interface IMetadataHandler

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.

getSchema

public String getSchema(ResultSet resultSet)
                 throws SQLException

Description copied from interface: IMetadataHandler

Returns the schema name to which the table of the current result set index belongs.

Specified by:

getSchema in interface IMetadataHandler

Parameters:

resultSet - The result set pointing to a valid record in the database that was returned by DatabaseMetaData.getTables(String, String, String, String[]).

Returns:

The name of the schema from the given result set

Throws:

SQLException - if a database access error occurs.

tableExists

public boolean tableExists(DatabaseMetaData metaData,
 String schema,
 String tableName)
                    throws SQLException

Description copied from interface: IMetadataHandler

Checks if the given table exists.

Specified by:

tableExists in interface IMetadataHandler

Parameters:

metaData - The database meta data

schema - The schema in which the table should be searched. If null the schema is not used to narrow the table name.

tableName - The table name to be searched

Returns:

Returns true if the given table exists in the given schema. Else returns false.

Throws:

SQLException - if a database access error occurs.

getTables

public ResultSet getTables(DatabaseMetaData metaData,
 String schemaName,
 String[] tableType)
                    throws SQLException

Description copied from interface: IMetadataHandler

Returns the tables in the given schema that matches one of the given tableTypes.

Specified by:

getTables in interface IMetadataHandler

Parameters:

metaData - The database meta data

schemaName - schema for which the tables should be retrieved; null returns all schemas

tableType - a list of table types to include; null returns all types

Returns:

The ResultSet which is retrieved using DatabaseMetaData.getTables(String, String, String, String[])

Throws:

SQLException - if a database access error occurs.

getPrimaryKeys

public ResultSet getPrimaryKeys(DatabaseMetaData metaData,
 String schemaName,
 String tableName)
                         throws SQLException

Description copied from interface: IMetadataHandler

Returns the primary keys of the given table.

Specified by:

getPrimaryKeys in interface IMetadataHandler

Parameters:

metaData - The database meta data

schemaName - schema for which the tables should be retrieved; null returns all schemas

tableName - table for which the primary keys are retrieved

Returns:

The ResultSet which is retrieved using DatabaseMetaData.getPrimaryKeys(String, String, String)

Throws:

SQLException - if a database access error occurs.

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/schema swap: MySQL's getColumns rows report only a catalog, not a schema, so when the search side expects a schema but the row has none, the row's catalog is compared against the searched schema instead.

Specified by:

matchesColumn in interface IMetadataHandler

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.

Specified by:

supportsColumnCache in interface IMetadataHandler

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.