org.jasig.portal.rdbm
Interface IDatabaseMetadata

All Known Implementing Classes:

DatabaseMetaDataImpl

public interface IDatabaseMetadata

Version:

$Revision: 19776 $ Apr 8, 2005

Author:

susan.bramhall@yale.edu

Method Summary

String	getDatabaseProductName()
String	getDatabaseProductVersion()
String	getJdbcDriver()
String	getJdbcDriverVersion()
String	getJdbcUrl()
String	getJdbcUser()
IJoinQueryString	getJoinQuery() Gets the appropriate IJoinQueryString implemenation for the database.
String	sqlTimeStamp() SQL TimeStamp format of current time.
String	sqlTimeStamp(Date date) SQL TimeStamp format a Date.
String	sqlTimeStamp(long date) SQL TimeStamp format a long.
boolean	supportsOuterJoins() Returns true if the database server supports outer joins.
boolean	supportsPreparedStatements() Returns true if the database server supports prepared statements.
boolean	supportsTransactions() Returns true if the database server supports transactions.

Method Detail

getJoinQuery

IJoinQueryString getJoinQuery()

Gets the appropriate IJoinQueryString implemenation for the database. If supportsOuterJoins() returns false this will return null.

Returns:

The appropriate IJoinQueryString implemenation.

supportsOuterJoins

boolean supportsOuterJoins()

Returns true if the database server supports outer joins. The query to use if this returns true can be retrieved from the getJoinQuery() method.

Returns:

true if the server supports outer joins.

supportsTransactions

boolean supportsTransactions()

Returns true if the database server supports transactions.

Returns:

true if the server supports transactions.

supportsPreparedStatements

boolean supportsPreparedStatements()

Returns true if the database server supports prepared statements.

Returns:

true if the server supports prepared statements.

sqlTimeStamp

String sqlTimeStamp()

SQL TimeStamp format of current time.

Returns:

SQL TimeStamp of the current time.

sqlTimeStamp

String sqlTimeStamp(long date)

SQL TimeStamp format a long.

Parameters:

date - The time in milliseconds to format.

Returns:

SQL TimeStamp of the specified time.

sqlTimeStamp

String sqlTimeStamp(Date date)

SQL TimeStamp format a Date.

Parameters:

date - The date to format.

Returns:

SQL TimeStamp or "NULL" if date is null.

getDatabaseProductName

String getDatabaseProductName()

Returns:

Database Name

getDatabaseProductVersion

String getDatabaseProductVersion()

Returns:

Database Version

getJdbcDriver

String getJdbcDriver()

Returns:

The JDBC Driver being used

getJdbcDriverVersion

String getJdbcDriverVersion()

Returns:

The JDBC Driver version

getJdbcUrl

String getJdbcUrl()

Returns:

The JDBC URL being used

getJdbcUser

String getJdbcUser()

Returns:

The JDBC user name