com.openindex.openestate.impl.db

Class NamedCallableStatement

java.lang.Object

com.openindex.openestate.impl.db.NamedCallableStatement

public class NamedCallableStatement
extends Object

This class wraps around a PreparedStatement and allows the programmer to set parameters by name instead of by index.

This eliminates any confusion as to which parameter index represents what. This also means that rearranging the SQL statement or adding a parameter doesn't involve renumbering your indices. Code such as this:

 Connection con=getConnection();
 String query="select * from my_table where name=? or address=?";
 PreparedStatement p=con.prepareStatement(query);
 p.setString(1, "bob");
 p.setString(2, "123 terrace ct");
 ResultSet rs=p.executeQuery();
 

can be replaced with:

 Connection con=getConnection();
 String query="select * from my_table where name=:name or
 address=:address";
 NamedParameterStatement p=new NamedParameterStatement(con, query);
 p.setString("name", "bob");
 p.setString("address", "123 terrace ct");
 ResultSet rs=p.executeQuery();
 

Author:

adam_crume, Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
NamedCallableStatement(Connection connection, String query) Creates a NamedParameterStatement.

Method Summary

Modifier and Type	Method and Description
void	addBatch() Adds the current set of parameters as a batch entry.
void	clearParameters()
void	close() Closes the statement.
boolean	execute() Executes the statement.
int[]	executeBatch() Executes all of the batched statements.
ResultSet	executeQuery() Executes the statement, which must be a query.
int	executeUpdate() Executes the statement, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.
int	getInt(String name)
long	getLong(String name)
Object	getObject(String name)
CallableStatement	getStatement() Returns the underlying statement.
String	getString(String name)
Timestamp	getTimestamp(String name)
void	registerOutParameter(String name, int sqlType)
void	registerOutParameter(String name, int sqlType, int scale)
void	registerOutParameter(String name, int sqlType, String typeName)
void	setBigDecimal(String name, BigDecimal value)
void	setBinaryStream(String name, InputStream input, int length)
void	setBoolean(String name, boolean value)
void	setDate(String name, Date value)
void	setDouble(String name, double value)
void	setInt(String name, int value) Sets a parameter.
void	setLong(String name, long value) Sets a parameter.
void	setNull(String name, int sqlType)
void	setNull(String name, int sqlType, String typeName)
void	setObject(String name, Object value) Sets a parameter.
void	setObject(String name, Object value, int type)
void	setString(String name, String value) Sets a parameter.
void	setTime(String name, Time value)
void	setTimestamp(String name, Timestamp value) Sets a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedCallableStatement

public NamedCallableStatement(Connection connection,
                              String query)
                       throws SQLException

Creates a NamedParameterStatement. Wraps a call to c.prepareStatement.

Parameters:

connection - the database connection

query - the parameterized query

Throws:

SQLException - if the statement could not be created

Method Detail

clearParameters

public void clearParameters()
                     throws SQLException

Throws:

SQLException

getObject

public Object getObject(String name)
                 throws SQLException

Throws:

SQLException

getString

public String getString(String name)
                 throws SQLException

Throws:

SQLException

getInt

public int getInt(String name)
           throws SQLException

Throws:

SQLException

getLong

public long getLong(String name)
             throws SQLException

Throws:

SQLException

getTimestamp

public Timestamp getTimestamp(String name)
                       throws SQLException

Throws:

SQLException

registerOutParameter

public void registerOutParameter(String name,
                                 int sqlType)
                          throws SQLException

Throws:

SQLException

registerOutParameter

public void registerOutParameter(String name,
                                 int sqlType,
                                 int scale)
                          throws SQLException

Throws:

SQLException

registerOutParameter

public void registerOutParameter(String name,
                                 int sqlType,
                                 String typeName)
                          throws SQLException

Throws:

SQLException

setObject

public void setObject(String name,
                      Object value)
               throws SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

SQLException - if an error occurred

IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setObject(int, java.lang.Object)

setObject

public void setObject(String name,
                      Object value,
                      int type)
               throws SQLException

Throws:

SQLException

setString

public void setString(String name,
                      String value)
               throws SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

SQLException - if an error occurred

IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setString(int, java.lang.String)

setInt

public void setInt(String name,
                   int value)
            throws SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

SQLException - if an error occurred

IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setInt(int, int)

setLong

public void setLong(String name,
                    long value)
             throws SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

SQLException - if an error occurred

IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setInt(int, int)

setTimestamp

public void setTimestamp(String name,
                         Timestamp value)
                  throws SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

SQLException - if an error occurred

IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setTimestamp(int, java.sql.Timestamp)

setTime

public void setTime(String name,
                    Time value)
             throws SQLException

Throws:

SQLException

setDate

public void setDate(String name,
                    Date value)
             throws SQLException

Throws:

SQLException

setBoolean

public void setBoolean(String name,
                       boolean value)
                throws SQLException

Throws:

SQLException

setDouble

public void setDouble(String name,
                      double value)
               throws SQLException

Throws:

SQLException

setBigDecimal

public void setBigDecimal(String name,
                          BigDecimal value)
                   throws SQLException

Throws:

SQLException

setBinaryStream

public void setBinaryStream(String name,
                            InputStream input,
                            int length)
                     throws SQLException

Throws:

SQLException

setNull

public void setNull(String name,
                    int sqlType)
             throws SQLException

Throws:

SQLException

setNull

public void setNull(String name,
                    int sqlType,
                    String typeName)
             throws SQLException

Throws:

SQLException

getStatement

public CallableStatement getStatement()

Returns the underlying statement.

Returns:

the statement

execute

public boolean execute()
                throws SQLException

Executes the statement.

Returns:

true if the first result is a ResultSet

Throws:

SQLException - if an error occurred

See Also:

PreparedStatement.execute()

executeQuery

public ResultSet executeQuery()
                       throws SQLException

Executes the statement, which must be a query.

Returns:

the query results

Throws:

SQLException - if an error occurred

See Also:

PreparedStatement.executeQuery()

executeUpdate

public int executeUpdate()
                  throws SQLException

Executes the statement, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.

Returns:

number of rows affected

Throws:

SQLException - if an error occurred

See Also:

PreparedStatement.executeUpdate()

close

public void close()
           throws SQLException

Closes the statement.

Throws:

SQLException - if an error occurred

See Also:

Statement.close()

addBatch

public void addBatch()
              throws SQLException

Adds the current set of parameters as a batch entry.

Throws:

SQLException - if something went wrong

executeBatch

public int[] executeBatch()
                   throws SQLException

Executes all of the batched statements.

See Statement.executeBatch() for details.

Returns:

update counts for each statement

Throws:

SQLException - if something went wrong