org.batoo.jpa.jdbc.dbutils

Class QueryRunner

java.lang.Object

org.batoo.jpa.jdbc.dbutils.QueryRunner

public class QueryRunner
extends Object

Executes SQL queries with pluggable strategies for handling ResultSets. This class is thread safe.

This class's code is based on original Apache DBUtils QueryRunner class.

See Also:

ResultSetHandler

Constructor Summary

Constructors

Constructor and Description
QueryRunner() Constructor for QueryRunner.
QueryRunner(boolean pmdKnownBroken, boolean hasLob) Constructor for QueryRunner, allows workaround for Oracle drivers
QueryRunner(DataSource datasource) Constructor for QueryRunner which takes a DataSource.
QueryRunner(DataSource datasource, boolean pmdKnownBroken) Constructor for QueryRunner, allows workaround for Oracle drivers.
QueryRunner(JdbcAdaptor jdbcAdaptor, boolean hasLob) Constructor for QueryRunner, allows workaround for Oracle drivers

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	query(Connection connection, String sql, org.apache.commons.dbutils.ResultSetHandler<T> rsh) Execute an SQL SELECT query without any replacement parameters.
<T> T	query(Connection connection, String sql, org.apache.commons.dbutils.ResultSetHandler<T> rsh, Object... params) Execute an SQL SELECT query with replacement parameters.
<T> T	query(String sql, org.apache.commons.dbutils.ResultSetHandler<T> rsh) Executes the given SELECT SQL without any replacement parameters.
<T> T	query(String sql, org.apache.commons.dbutils.ResultSetHandler<T> rsh, Object... params) Executes the given SELECT SQL query and returns a result object.
int	update(Connection connection, String sql) Execute an SQL INSERT, UPDATE, or DELETE query without replacement parameters.
int	update(Connection connection, String sql, Object... params) Execute an SQL INSERT, UPDATE, or DELETE query.
int	update(String sql) Executes the given INSERT, UPDATE, or DELETE SQL statement without any replacement parameters.
int	update(String sql, Object... params) Executes the given INSERT, UPDATE, or DELETE SQL statement.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryRunner

public QueryRunner()

Constructor for QueryRunner.

QueryRunner

public QueryRunner(boolean pmdKnownBroken,
           boolean hasLob)

Constructor for QueryRunner, allows workaround for Oracle drivers

Parameters:

pmdKnownBroken - Oracle drivers don't support ParameterMetaData.getParameterType(int); if pmdKnownBroken is set to true, we won't even try it; if false, we'll try it, and if it breaks, we'll remember not to use it again.

hasLob - if the query has lob parameters

QueryRunner

public QueryRunner(DataSource datasource)

Constructor for QueryRunner which takes a DataSource. Methods that do not take a Connection parameter will retrieve connections from this DataSource.

Parameters:

datasource - The DataSource to retrieve connections from.

QueryRunner

public QueryRunner(DataSource datasource,
           boolean pmdKnownBroken)

Constructor for QueryRunner, allows workaround for Oracle drivers. Methods that do not take a Connection parameter will retrieve connections from this DataSource.

Parameters:

datasource - The DataSource to retrieve connections from.

pmdKnownBroken - Oracle drivers don't support ParameterMetaData.getParameterType(int); if pmdKnownBroken is set to true, we won't even try it; if false, we'll try it, and if it breaks, we'll remember not to use it again.

QueryRunner

public QueryRunner(JdbcAdaptor jdbcAdaptor,
           boolean hasLob)

Constructor for QueryRunner, allows workaround for Oracle drivers

Parameters:

jdbcAdaptor - the JDBC adaptor

hasLob - if the query has lob parameters

Method Detail

query

public <T> T query(Connection connection,
          String sql,
          org.apache.commons.dbutils.ResultSetHandler<T> rsh)
        throws SQLException

Execute an SQL SELECT query without any replacement parameters. The caller is responsible for closing the connection.

Type Parameters:

T - The type of object that the handler returns

Parameters:

connection - The connection to execute the query in.

sql - The query to execute.

rsh - The handler that converts the results into an object.

Returns:

The object returned by the handler.

Throws:

SQLException - if a database access error occurs

query

public <T> T query(Connection connection,
          String sql,
          org.apache.commons.dbutils.ResultSetHandler<T> rsh,
          Object... params)
        throws SQLException

Execute an SQL SELECT query with replacement parameters. The caller is responsible for closing the connection.

Type Parameters:

T - The type of object that the handler returns

Parameters:

connection - The connection to execute the query in.

sql - The query to execute.

rsh - The handler that converts the results into an object.

params - The replacement parameters.

Returns:

The object returned by the handler.

Throws:

SQLException - if a database access error occurs

query

public <T> T query(String sql,
          org.apache.commons.dbutils.ResultSetHandler<T> rsh)
        throws SQLException

Executes the given SELECT SQL without any replacement parameters. The Connection is retrieved from the DataSource set in the constructor.

Type Parameters:

T - The type of object that the handler returns

Parameters:

sql - The SQL statement to execute.

rsh - The handler used to create the result object from the ResultSet.

Returns:

An object generated by the handler.

Throws:

SQLException - if a database access error occurs

query

public <T> T query(String sql,
          org.apache.commons.dbutils.ResultSetHandler<T> rsh,
          Object... params)
        throws SQLException

Executes the given SELECT SQL query and returns a result object. The Connection is retrieved from the DataSource set in the constructor.

Type Parameters:

T - The type of object that the handler returns

Parameters:

sql - The SQL statement to execute.

rsh - The handler used to create the result object from the ResultSet.

params - Initialize the PreparedStatement's IN parameters with this array.

Returns:

An object generated by the handler.

Throws:

SQLException - if a database access error occurs

update

public int update(Connection connection,
         String sql)
           throws SQLException

Execute an SQL INSERT, UPDATE, or DELETE query without replacement parameters.

Parameters:

connection - The connection to use to run the query.

sql - The SQL to execute.

Returns:

The number of rows updated.

Throws:

SQLException - if a database access error occurs

update

public int update(Connection connection,
         String sql,
         Object... params)
           throws SQLException

Execute an SQL INSERT, UPDATE, or DELETE query.

Parameters:

connection - The connection to use to run the query.

sql - The SQL to execute.

params - The query replacement parameters.

Returns:

The number of rows updated.

Throws:

SQLException - if a database access error occurs

update

public int update(String sql)
           throws SQLException

Executes the given INSERT, UPDATE, or DELETE SQL statement without any replacement parameters. The Connection is retrieved from the DataSource set in the constructor. This Connection must be in auto-commit mode or the update will not be saved.

Parameters:

sql - The SQL statement to execute.

Returns:

The number of rows updated.

Throws:

SQLException - if a database access error occurs

update

public int update(String sql,
         Object... params)
           throws SQLException

Executes the given INSERT, UPDATE, or DELETE SQL statement. The Connection is retrieved from the DataSource set in the constructor. This Connection must be in auto-commit mode or the update will not be saved.

Parameters:

sql - The SQL statement to execute.

params - Initializes the PreparedStatement's IN (i.e. '?') parameters.

Returns:

The number of rows updated.

Throws:

SQLException - if a database access error occurs