com.xdev.jadoth.sqlengine.internal

Class DatabaseGateway<A extends DbmsAdaptor<A>>

java.lang.Object

com.xdev.jadoth.sqlengine.internal.DatabaseGateway<A>

Type Parameters:

A - the generic type

public class DatabaseGateway<A extends DbmsAdaptor<A>>
extends Object

This class handles access to one concrete database instance.
It holds the DdmsAdaptor and ConnectionProvider instances for use with query objects that shall be executed, as well as some common execution logic itself.

Author:

Thomas Muenz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	connectionEnabled The connection enabled.
protected ConnectionProvider<A>	connectionProvider The connection provider.
protected A	dbmsAdaptor The dbms adaptor.
boolean	indexValidation_createMissingIndices The index validation_create missing indices.
boolean	indexValidation_dropUndefinedIndices The index validation_drop undefined indices.
boolean	indexValidationEnabled The index validation enabled.
boolean	validateTableColumns The validate table columns.

Constructor Summary

Constructors

Constructor and Description
DatabaseGateway(ConnectionProvider<A> connectionProvider) Instantiates a new database gateway.

Method Summary

Modifier and Type	Method and Description
void	close() Close.
DatabaseGateway<A>	connect() Connect.
void	dropIndex(SqlIndex index) Drop index.
static <A extends DbmsAdaptor<A>,R> R	execute(DatabaseGateway<A> databaseGateway, Query query, LoggingContext loggingContext, SqlExecutor<R> executor, Object... parameters)
<R> R	execute(SqlExecutor<R> executor, String sql)
Connection	getConnection() Gets the connection.
A	getDbmsAdaptor() Gets the dbms adaptor.
boolean	isConnectionEnabled() Checks if is connection enabled.
void	setConnectionEnabled(boolean connectionEnabled) Sets the connection enabled.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

connectionProvider

protected ConnectionProvider<A extends DbmsAdaptor<A>> connectionProvider

The connection provider.

dbmsAdaptor

protected A extends DbmsAdaptor<A> dbmsAdaptor

The dbms adaptor.

validateTableColumns

public final boolean validateTableColumns

The validate table columns.

See Also:

Constant Field Values

indexValidationEnabled

public final boolean indexValidationEnabled

The index validation enabled.

See Also:

Constant Field Values

indexValidation_createMissingIndices

public final boolean indexValidation_createMissingIndices

The index validation_create missing indices.

See Also:

Constant Field Values

indexValidation_dropUndefinedIndices

public final boolean indexValidation_dropUndefinedIndices

The index validation_drop undefined indices.

See Also:

Constant Field Values

connectionEnabled

protected boolean connectionEnabled

The connection enabled.

Constructor Detail

DatabaseGateway

public DatabaseGateway(ConnectionProvider<A> connectionProvider)

Instantiates a new database gateway.

Parameters:

connectionProvider - the connection provider

Method Detail

close

public void close()
           throws SQLEngineException

Close.

Throws:

SQLEngineException - the sQL engine exception

getDbmsAdaptor

public A getDbmsAdaptor()

Gets the dbms adaptor.

Returns:

the dbms adaptor

connect

public DatabaseGateway<A> connect()
                           throws SQLEngineCouldNotConnectToDBException

Connect.

Returns:

the database gateway

Throws:

SQLEngineCouldNotConnectToDBException - the sQL engine could not connect to db exception

getConnection

public Connection getConnection()

Gets the connection.

Returns:

the connection

execute

public static final <A extends DbmsAdaptor<A>,R> R execute(DatabaseGateway<A> databaseGateway,
                                                           Query query,
                                                           LoggingContext loggingContext,
                                                           SqlExecutor<R> executor,
                                                           Object... parameters)

execute

public <R> R execute(SqlExecutor<R> executor,
                     String sql)
              throws SQLEngineException

Throws:

SQLEngineException

dropIndex

public void dropIndex(SqlIndex index)
               throws SQLEngineException

Drop index.

Parameters:

index - the index

Throws:

SQLEngineException - the sQL engine exception

isConnectionEnabled

public boolean isConnectionEnabled()

Checks if is connection enabled.

Returns:

the connectionEnabled

setConnectionEnabled

public void setConnectionEnabled(boolean connectionEnabled)

Sets the connection enabled.

Parameters:

connectionEnabled - the connectionEnabled to set

toString

public String toString()

Overrides:

toString in class Object

Returns:

See Also:

Object.toString()