org.jboss.dna.common.jdbc.provider
Interface DatabaseMetadataProvider

All Superinterfaces:

Serializable

All Known Subinterfaces:

DataSourceDatabaseMetadataProvider, DriverDatabaseMetadataProvider

All Known Implementing Classes:

DefaultDatabaseMetadataProvider, DefaultDataSourceDatabaseMetadataProvider, DefaultDriverDatabaseMetadataProvider

public interface DatabaseMetadataProvider
extends Serializable

Database Meta data provider

Author:

Sergiy Litsenko

Method Summary

Connection	getConnection() Returns database connection
DatabaseMetaData	getDatabaseMetaData() Returns database metadata
String	getEmptyStringNotation() Get provider's notation for empty string
String	getName() Returns DatabaseMetadataProvider logical name
String	getNullStringNotation() Get provider's notation for NULL string
Properties	getProperties() Returns provider properties
void	release(boolean silently) Releases database resources
void	setEmptyStringNotation(String emptyStringNotation) Set provider's notation for empty string
void	setName(String name) Sets the DatabaseMetadataProvider logical name
void	setNullStringNotation(String nullStringNotation) Set provider's notation for NULL string
void	setProperties(Properties properties) Sets the provider properties

Method Detail

release

void release(boolean silently)

Releases database resources

Parameters:

silently - if true never generates Exception; otherwise mage rethrow RunTimeException

getDatabaseMetaData

DatabaseMetaData getDatabaseMetaData()
                                     throws Exception

Returns database metadata

Returns:

database metadata

Throws:

Exception

getConnection

Connection getConnection()
                         throws Exception

Returns database connection

Returns:

database connection

Throws:

Exception

getName

String getName()

Returns DatabaseMetadataProvider logical name

Returns:

the DatabaseMetadataProvider logical name

setName

void setName(String name)

Sets the DatabaseMetadataProvider logical name

Parameters:

name - the DatabaseMetadataProvider logical name

getEmptyStringNotation

String getEmptyStringNotation()

Get provider's notation for empty string

Returns:

provider's notation for empty string

setEmptyStringNotation

void setEmptyStringNotation(String emptyStringNotation)

Set provider's notation for empty string

Parameters:

emptyStringNotation - the provider's notation for empty string

getNullStringNotation

String getNullStringNotation()

Get provider's notation for NULL string

Returns:

provider's notation for NULL string

setNullStringNotation

void setNullStringNotation(String nullStringNotation)

Set provider's notation for NULL string

Parameters:

nullStringNotation - the provider's notation for NULL string

getProperties

Properties getProperties()

Returns provider properties

Returns:

provider properties

setProperties

void setProperties(Properties properties)

Sets the provider properties

Parameters:

properties - the provider properties