|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSRelationalPushDownHelper
This interface provides helper methods that can be used by customers in their implementations of their <beanName>UserDefinedPushDownMethods classes. This sub-interface adds relational-specific helpers beyond the generic helpers available in the super-interface.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
javax.resource.cci.ResultSet |
createCCIResultSet(java.sql.ResultSet resultSet,
java.lang.Object connection)
This method creates a CCI ResultSet corresponding to the given SQL ResultSet. |
java.sql.Statement |
createStatement(java.lang.Object conn)
This method gets a generic JDBC Statement from the connection. |
sqlj.runtime.ref.DefaultContext |
getConnectionContext(java.lang.Object conn)
This method returns a SQLj connection context. |
int |
getLockType(java.lang.Object connection,
AccessIntent accessIntent)
This method returns the type of lock to be used for the current interaction with the back-end data store. |
java.sql.CallableStatement |
prepareCall(java.lang.Object conn,
java.lang.String sql)
This method gets a JDBC CallableStatement from the connection with the given SQL statement. |
java.sql.CallableStatement |
prepareCall(java.lang.Object conn,
java.lang.String sql,
int resultSetType,
int resultSetConcurrency)
This method gets a JDBC CallableStatement from the connection with the given SQL statement. |
java.sql.PreparedStatement |
prepareStatement(java.lang.Object conn,
java.lang.String sql)
This method gets a JDBC PreparedStatement from the connection. |
void |
returnCCIResultSet(javax.resource.cci.ResultSet resultSet)
This method returns a CCI ResultSet to the cache. |
void |
returnPreparedStatement(java.lang.Object conn,
java.sql.PreparedStatement stmt)
This method returns a JDBC PreparedStatement to the cache. |
Methods inherited from interface com.ibm.wbiserver.cmpa.WSPushDownHelper |
---|
createCCIIndexedRecord, createCCIRecord, createResourceException, createResourceException, returnCCIIndexedRecord |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
java.sql.Statement createStatement(java.lang.Object conn) throws javax.resource.ResourceException
This method gets a generic JDBC Statement from the connection. This should only be used if neither a PreparedStatement nor a CallableStatement is desired.
conn
- the connection from which to get the statement. This should
be the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.
javax.resource.ResourceException
- thrown if an error occurs getting the
Statement.java.sql.PreparedStatement prepareStatement(java.lang.Object conn, java.lang.String sql) throws javax.resource.ResourceException
This method gets a JDBC PreparedStatement from the connection. A cache is used to improve performance; when done with the PreparedStatement, use the returnPreparedStatement method to return it to the cache.
conn
- the connection from which to get the statement. This should
be the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.sql
- the SQL statement.
javax.resource.ResourceException
- thrown if an error occurs getting the
PreparedStatement.void returnPreparedStatement(java.lang.Object conn, java.sql.PreparedStatement stmt) throws javax.resource.ResourceException
This method returns a JDBC PreparedStatement to the cache.
conn
- the connection from which to get the statement. This should
be the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.stmt
- The PreparedStatement to return to the cache
javax.resource.ResourceException
- thrown if an error occurs returning the
PreparedStatement.java.sql.CallableStatement prepareCall(java.lang.Object conn, java.lang.String sql) throws javax.resource.ResourceException
This method gets a JDBC CallableStatement from the connection with the given SQL statement.
conn
- the connection from which to get the statement. This should
be the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.sql
- the SQL statement.
javax.resource.ResourceException
- thrown if an error occurs getting the
CallableStatement.java.sql.CallableStatement prepareCall(java.lang.Object conn, java.lang.String sql, int resultSetType, int resultSetConcurrency) throws javax.resource.ResourceException
This method gets a JDBC CallableStatement from the connection with the given SQL statement.
conn
- the connection from which to get the statement. This should
be the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.sql
- the SQL statement.resultSetType
- a result set type; see ResultSet.TYPE_XXXresultSetConcurrency
- a concurrency type; see ResultSet.CONCUR_XXX
javax.resource.ResourceException
- thrown if an error occurs getting the
CallableStatement.javax.resource.cci.ResultSet createCCIResultSet(java.sql.ResultSet resultSet, java.lang.Object connection) throws javax.resource.ResourceException
This method creates a CCI ResultSet corresponding to the given SQL ResultSet. Such a CCI ResultSet can be returned from a method in the UserDefinedPushDownMethodsImpl, if the data in the result set is arranged in expected order (as documented in the generated JavaDoc comments for the UserDefinedPushDownMethodsImpl method).
If the specified object is already a javax.resource.cci.ResultSet, this method will return the specified object unchanged. Otherwise, this java.sql.ResultSet object will be wrapped in a CCI ResultSet.
resultSet
- an SQL ResultSet to be wrapped in the CCI ResultSet.connection
- the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.
javax.resource.ResourceException
- thrown if an error occurs creating the
CCI ResultSetvoid returnCCIResultSet(javax.resource.cci.ResultSet resultSet) throws javax.resource.ResourceException
This method returns a CCI ResultSet to the cache.
resultSet
- a CCI ResultSet
javax.resource.ResourceException
- thrown if an error occurs returning the
CCI ResultSet to the cachesqlj.runtime.ref.DefaultContext getConnectionContext(java.lang.Object conn) throws javax.resource.ResourceException
This method returns a SQLj connection context. This context contains the physical connection.
conn
- the connection from which to get the context. This should
be the connection object passed in to the method of the
UserDefinedPushDownMethods implementation class.
javax.resource.ResourceException
- thrown if an error occurs creating the SQLj
connection contextint getLockType(java.lang.Object connection, AccessIntent accessIntent) throws javax.resource.ResourceException
This method returns the type of lock to be used for the current interaction with the back-end data store.
connection
- The current connection that is passed to the UserDefinedPushDownMethodsImpl
class. It must implement the javax.resource.cci.Connection interface.accessIntent
- This class holds access-intent-related info of potential use by any
UserDefinedPushDownMethodsImpl class. This method uses this parameter to
locate the correct locktype in order to choose the right SQL Select syntax.
javax.resource.ResourceException
- thrown if the connection can not be cast to javax.resource.cci.ConnectionEJBToRAAdapter.getLockType(ConnectionFactory, AccessIntent)
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |