org.arp.javautil.sql

Class DatabaseMetaDataWrapper

java.lang.Object

org.arp.javautil.sql.DatabaseMetaDataWrapper

public class DatabaseMetaDataWrapper
extends Object

Wraps the DatabaseMetaData class to provide some additional methods for using database metadata.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
DatabaseMetaDataWrapper(DatabaseMetaData metaData) Creates the wrapper.

Method Summary

Modifier and Type	Method and Description
boolean	isDatabaseCompatible(String databaseProductNameRegex, DatabaseVersion minVersion, DatabaseVersion maxVersion) Compares database product name and version information to that reported by the database.
boolean	isDriverCompatible(String driverName, DriverVersion minVersion, DriverVersion maxVersion) Compares JDBC driver name and version information to that reported by the driver.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseMetaDataWrapper

public DatabaseMetaDataWrapper(DatabaseMetaData metaData)

Creates the wrapper.

Parameters:

metaData - the DatabaseMetaData instance to wrap.

Method Detail

isDatabaseCompatible

public boolean isDatabaseCompatible(String databaseProductNameRegex,
                                    DatabaseVersion minVersion,
                                    DatabaseVersion maxVersion)
                             throws SQLException

Compares database product name and version information to that reported by the database.

Parameters:

databaseProductNameRegex - a regular expression that the actual database product name will match. Use a regular expression that is unlikely to overlap with the product names of other database systems.

minVersion - the expected minimum version, if any.

maxVersion - the expected maximum version, if any.

Returns:

whether the actual database product name and version match the provided arguments. The database product name comparison checks whether the actual database product name matches the provided database product name regular expression. The min and max version comparisons are inclusive.

Throws:

SQLException - if an error occurs fetching metadata containing the database product name and version from the database.

isDriverCompatible

public boolean isDriverCompatible(String driverName,
                                  DriverVersion minVersion,
                                  DriverVersion maxVersion)
                           throws SQLException

Compares JDBC driver name and version information to that reported by the driver.

Parameters:

driverName - the expected driver name.

minVersion - the expected minimum version, if any.

maxVersion - the expected maximum version, if any.

Returns:

whether the actual JDBC driver name and version match the provided arguments. The min and max version comparisons are inclusive.

Throws:

SQLException - if an error occurs fetching metadata containing the JDBC driver name and version from the database.