org.apache.ojb.broker.platforms
Class PlatformDefaultImpl

java.lang.Object
  extended byorg.apache.ojb.broker.platforms.PlatformDefaultImpl
All Implemented Interfaces:
JoinSyntaxTypes, Platform
Direct Known Subclasses:
PlatformDb2Impl, PlatformFirebirdImpl, PlatformHsqldbImpl, PlatformInformixImpl, PlatformMsAccessImpl, PlatformMsSQLServerImpl, PlatformMySQLImpl, PlatformOracleImpl, PlatformPostgreSQLImpl, PlatformSapdbImpl, PlatformSybaseImpl

public class PlatformDefaultImpl
extends java.lang.Object
implements Platform, JoinSyntaxTypes

This class is a concrete implementation of Platform. Provides default implementations for all methods declared in Platform. It is intended as a vanilla implementation and as baseclass for platform specific implementations.

Version:
$Id: PlatformDefaultImpl.java,v 1.24 2004/02/21 21:41:45 brj Exp $
Author:
Thomas Mahler

Field Summary
protected  Logger log
           
protected  boolean m_batchUpdatesChecked
           
protected  boolean m_supportsBatchUpdates
           
 
Fields inherited from interface org.apache.ojb.broker.accesslayer.JoinSyntaxTypes
ORACLE_JOIN_SYNTAX, SQL92_JOIN_SYNTAX, SQL92_NOPAREN_JOIN_SYNTAX, SYBASE_JOIN_SYNTAX
 
Constructor Summary
PlatformDefaultImpl()
           
 
Method Summary
 void addBatch(java.sql.PreparedStatement stmt)
           
 void addPagingSql(java.lang.StringBuffer anSqlString)
          Add the LIMIT or equivalent to the SQL SQL-Paging is not yet supported
 void afterStatementClose(java.sql.Statement stmt, java.sql.ResultSet rs)
          Called by StatementManager implementation after invoke stmt.close() method.
 void afterStatementCreate(java.sql.Statement stmt)
          Called after a jdbc-m_connection statement was created.
 void beforeBatch(java.sql.PreparedStatement stmt)
           
 void beforeStatementClose(java.sql.Statement stmt, java.sql.ResultSet rs)
          Called by StatementManager implementation before invoke stmt.close() method.
 int bindPagingParameters(java.sql.PreparedStatement ps, int index, int startAt, int endAt)
          Bind the Paging Parameters SQL-Paging is not yet supported
 boolean bindPagingParametersFirst()
          Answer true if the LIMIT parameters are bound before the query parameters SQL-Paging is not yet supported
 void changeAutoCommitState(JdbcConnectionDescriptor jcd, java.sql.Connection con, boolean newState)
          Used to do a temporary change of the m_connection autoCommit state.
protected  void checkForBatchSupport(java.sql.Connection conn)
          Sets platform information for if the jdbc driver/db combo support batch operations.
 java.lang.String concatenate(java.lang.String[] theColumns)
          Concatenate the columns
ie: col1 || col2 || col3 (ANSI)
ie: col1 + col2 + col3 (MS SQL-Server)
ie: concat(col1, col2, col3) (MySql)
 java.lang.String createSequenceQuery(java.lang.String sequenceName)
          Override this method to enable database based sequence generation
 java.lang.String dropSequenceQuery(java.lang.String sequenceName)
          Override this method to enable database based sequence generation
 int[] executeBatch(java.sql.PreparedStatement stmt)
           
protected  java.lang.String getConcatenationCharacter()
          Answer the Character for Concatenation
 java.lang.String getEscapeClause(LikeCriteria aCriteria)
          Answer the Clause used Escape wildcards in LIKE
 byte getJoinSyntaxType()
          Get join syntax type for this RDBMS - one on of the constants from JoinSyntaxType interface
 java.lang.String getLastInsertIdentityQuery(java.lang.String tableName)
          If database supports native key generation via identity column, this method should return the sql-query to obtain the last generated id.
 void initializeJdbcConnection(JdbcConnectionDescriptor jcd, java.sql.Connection conn)
          callback called immediately after a JDBC Connection has been obtained in ...
 java.lang.String nextSequenceQuery(java.lang.String sequenceName)
          Override this method to enable database based sequence generation
 java.sql.CallableStatement prepareNextValProcedureStatement(java.sql.Connection con, java.lang.String procedureName, java.lang.String sequenceName)
          Create stored procedure call for a special sequence manager implementation SequenceManagerStoredProcedureImpl, because it seems that jdbc-driver differ in handling of CallableStatement.
 void setNullForStatement(java.sql.PreparedStatement ps, int index, int sqlType)
          some JDBC-Drivers do not support all sqlTypes this callback is used set parameters to a PreparedStatement
 void setObjectForStatement(java.sql.PreparedStatement ps, int index, java.lang.Object value, int sqlType)
          some JDBC-Drivers do not support all sqlTypes this callback is used set parameters to a PreparedStatement
 boolean supportsBatchOperations()
          if this platform supports the batch operations jdbc 2.0 feature.
 boolean supportsPaging()
          Answer true if LIMIT or equivalent is supported SQL-Paging is not yet supported
 boolean useCountForResultsetSize()
          Override default ResultSet size determination (rs.last();rs.getRow()) with select count(*) operation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected Logger log

m_batchUpdatesChecked

protected boolean m_batchUpdatesChecked

m_supportsBatchUpdates

protected boolean m_supportsBatchUpdates
Constructor Detail

PlatformDefaultImpl

public PlatformDefaultImpl()
Method Detail

supportsBatchOperations

public boolean supportsBatchOperations()
Description copied from interface: Platform
if this platform supports the batch operations jdbc 2.0 feature. This is by driver, so we check the driver's metadata once and set something in the platform.

Specified by:
supportsBatchOperations in interface Platform
Returns:
true if the platform supports batch, false otherwise.

checkForBatchSupport

protected void checkForBatchSupport(java.sql.Connection conn)
Sets platform information for if the jdbc driver/db combo support batch operations. Will only be checked once, then have same batch support setting for the entire session.

Parameters:
conn -

afterStatementCreate

public void afterStatementCreate(java.sql.Statement stmt)
                          throws PlatformException
Description copied from interface: Platform
Called after a jdbc-m_connection statement was created.

Specified by:
afterStatementCreate in interface Platform
Throws:
PlatformException

beforeStatementClose

public void beforeStatementClose(java.sql.Statement stmt,
                                 java.sql.ResultSet rs)
                          throws PlatformException
Description copied from interface: Platform
Called by StatementManager implementation before invoke stmt.close() method.

Specified by:
beforeStatementClose in interface Platform
Throws:
PlatformException

afterStatementClose

public void afterStatementClose(java.sql.Statement stmt,
                                java.sql.ResultSet rs)
                         throws PlatformException
Description copied from interface: Platform
Called by StatementManager implementation after invoke stmt.close() method.

Specified by:
afterStatementClose in interface Platform
Throws:
PlatformException

beforeBatch

public void beforeBatch(java.sql.PreparedStatement stmt)
                 throws PlatformException
Specified by:
beforeBatch in interface Platform
Parameters:
stmt - the statement you want to batch on
Throws:
PlatformException

addBatch

public void addBatch(java.sql.PreparedStatement stmt)
              throws PlatformException
Specified by:
addBatch in interface Platform
Parameters:
stmt - the statement you are adding to the batch
Throws:
PlatformException

executeBatch

public int[] executeBatch(java.sql.PreparedStatement stmt)
                   throws PlatformException
Specified by:
executeBatch in interface Platform
Parameters:
stmt - the statement you want to execute the batch on
Throws:
PlatformException

initializeJdbcConnection

public void initializeJdbcConnection(JdbcConnectionDescriptor jcd,
                                     java.sql.Connection conn)
                              throws PlatformException
Description copied from interface: Platform
callback called immediately after a JDBC Connection has been obtained in ...

Specified by:
initializeJdbcConnection in interface Platform
Parameters:
conn - the Connection to be initialized
Throws:
PlatformException
See Also:
Platform.initializeJdbcConnection(org.apache.ojb.broker.metadata.JdbcConnectionDescriptor, java.sql.Connection)

changeAutoCommitState

public void changeAutoCommitState(JdbcConnectionDescriptor jcd,
                                  java.sql.Connection con,
                                  boolean newState)
Description copied from interface: Platform
Used to do a temporary change of the m_connection autoCommit state. When using this method ensure to reset the original state before m_connection was returned to pool or closed. Only when JdbcConnectionDescriptor.getUseAutoCommit() was set to JdbcConnectionDescriptor.AUTO_COMMIT_SET_TRUE_AND_TEMPORARY_FALSE the change of the autoCommit state take effect.

Specified by:
changeAutoCommitState in interface Platform

setObjectForStatement

public void setObjectForStatement(java.sql.PreparedStatement ps,
                                  int index,
                                  java.lang.Object value,
                                  int sqlType)
                           throws java.sql.SQLException
Description copied from interface: Platform
some JDBC-Drivers do not support all sqlTypes this callback is used set parameters to a PreparedStatement

Specified by:
setObjectForStatement in interface Platform
Throws:
java.sql.SQLException

setNullForStatement

public void setNullForStatement(java.sql.PreparedStatement ps,
                                int index,
                                int sqlType)
                         throws java.sql.SQLException
Description copied from interface: Platform
some JDBC-Drivers do not support all sqlTypes this callback is used set parameters to a PreparedStatement

Specified by:
setNullForStatement in interface Platform
Throws:
java.sql.SQLException

getJoinSyntaxType

public byte getJoinSyntaxType()
Get join syntax type for this RDBMS - one on of the constants from JoinSyntaxType interface

Specified by:
getJoinSyntaxType in interface Platform
See Also:
Platform.getJoinSyntaxType()

useCountForResultsetSize

public boolean useCountForResultsetSize()
Override default ResultSet size determination (rs.last();rs.getRow()) with select count(*) operation

Specified by:
useCountForResultsetSize in interface Platform
See Also:
Platform.useCountForResultsetSize()

createSequenceQuery

public java.lang.String createSequenceQuery(java.lang.String sequenceName)
Override this method to enable database based sequence generation

Specified by:
createSequenceQuery in interface Platform
Returns:
a sql string to create a sequence

nextSequenceQuery

public java.lang.String nextSequenceQuery(java.lang.String sequenceName)
Override this method to enable database based sequence generation

Specified by:
nextSequenceQuery in interface Platform
Returns:
a sql string to get next sequence value

dropSequenceQuery

public java.lang.String dropSequenceQuery(java.lang.String sequenceName)
Override this method to enable database based sequence generation

Specified by:
dropSequenceQuery in interface Platform
Returns:
a sql string to drop a sequence

prepareNextValProcedureStatement

public java.sql.CallableStatement prepareNextValProcedureStatement(java.sql.Connection con,
                                                                   java.lang.String procedureName,
                                                                   java.lang.String sequenceName)
                                                            throws PlatformException
Description copied from interface: Platform
Create stored procedure call for a special sequence manager implementation SequenceManagerStoredProcedureImpl, because it seems that jdbc-driver differ in handling of CallableStatement.
Note: The out-parameter of the stored procedure must be registered at first position, because lookup for new long id in the implementation:
 Connection con = broker.serviceConnectionManager().getConnection();
 cs = getPlatform().prepareNextValProcedureStatement(con, PROCEDURE_NAME, sequenceName);
 cs.executeUpdate();
 return cs.getLong(1);
 

Specified by:
prepareNextValProcedureStatement in interface Platform
Throws:
PlatformException

getLastInsertIdentityQuery

public java.lang.String getLastInsertIdentityQuery(java.lang.String tableName)
Description copied from interface: Platform
If database supports native key generation via identity column, this method should return the sql-query to obtain the last generated id.

Specified by:
getLastInsertIdentityQuery in interface Platform

addPagingSql

public void addPagingSql(java.lang.StringBuffer anSqlString)
Description copied from interface: Platform
Add the LIMIT or equivalent to the SQL SQL-Paging is not yet supported

Specified by:
addPagingSql in interface Platform
See Also:
Platform.addPagingSql(java.lang.StringBuffer)

bindPagingParametersFirst

public boolean bindPagingParametersFirst()
Description copied from interface: Platform
Answer true if the LIMIT parameters are bound before the query parameters SQL-Paging is not yet supported

Specified by:
bindPagingParametersFirst in interface Platform
Returns:
See Also:
Platform.bindPagingParametersFirst()

supportsPaging

public boolean supportsPaging()
Description copied from interface: Platform
Answer true if LIMIT or equivalent is supported SQL-Paging is not yet supported

Specified by:
supportsPaging in interface Platform
Returns:
See Also:
Platform.supportsPaging()

bindPagingParameters

public int bindPagingParameters(java.sql.PreparedStatement ps,
                                int index,
                                int startAt,
                                int endAt)
                         throws java.sql.SQLException
Description copied from interface: Platform
Bind the Paging Parameters SQL-Paging is not yet supported

Specified by:
bindPagingParameters in interface Platform
Parameters:
ps -
index - parameter index
startAt -
endAt -
Returns:
Throws:
java.sql.SQLException
See Also:
Platform.bindPagingParameters(java.sql.PreparedStatement, int, int, int)

getConcatenationCharacter

protected java.lang.String getConcatenationCharacter()
Answer the Character for Concatenation


concatenate

public java.lang.String concatenate(java.lang.String[] theColumns)
Description copied from interface: Platform
Concatenate the columns
ie: col1 || col2 || col3 (ANSI)
ie: col1 + col2 + col3 (MS SQL-Server)
ie: concat(col1, col2, col3) (MySql)

Specified by:
concatenate in interface Platform
Parameters:
theColumns -
Returns:
the concatenated String
See Also:
Platform.concatenate(java.lang.String[])

getEscapeClause

public java.lang.String getEscapeClause(LikeCriteria aCriteria)
Description copied from interface: Platform
Answer the Clause used Escape wildcards in LIKE

Specified by:
getEscapeClause in interface Platform
Parameters:
aCriteria -
Returns:
See Also:
Platform.getEscapeClause(org.apache.ojb.broker.query.LikeCriteria)


Authors: Thomas Mahler and others. (C) 2000 - 2003 Apache Software Foundation
All rights reserved. Published under the Apache License.
http://db.apache.org/ojb
Version: 1.0.rc5, 2003-12-14