com.dsf.utils.sql

Class NamedParameterStatement

java.lang.Object

com.dsf.utils.sql.NamedParameterStatement

public class NamedParameterStatement
extends java.lang.Object

Reference: http://www.javaworld.com/article/2077706/core-java/named-parameters-for-preparedstatement.html

Author:

Adam Crume

Constructor Summary

Constructors

Constructor and Description
NamedParameterStatement(java.sql.Connection connection, java.lang.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	close() Closes the statement.
boolean	execute() Executes the statement.
int[]	executeBatch() Executes all of the batched statements.
java.sql.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.
java.sql.PreparedStatement	getStatement() Returns the underlying statement.
void	setInt(java.lang.String name, int value) Sets a parameter.
void	setLong(java.lang.String name, long value) Sets a parameter.
void	setObject(java.lang.String name, java.lang.Object value) Sets a parameter.
void	setString(java.lang.String name, java.lang.String value) Sets a parameter.
void	setTimestamp(java.lang.String name, java.sql.Timestamp value) Sets a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedParameterStatement

public NamedParameterStatement(java.sql.Connection connection,
                               java.lang.String query)
                        throws java.sql.SQLException

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

Parameters:

connection - the database connection

query - the parameterized query

Throws:

java.sql.SQLException - if the statement could not be created

Method Detail

setObject

public void setObject(java.lang.String name,
                      java.lang.Object value)
               throws java.sql.SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

java.sql.SQLException - if an error occurred

java.lang.IllegalArgumentException - if the parameter does not exist

See Also:

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

setString

public void setString(java.lang.String name,
                      java.lang.String value)
               throws java.sql.SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

java.sql.SQLException - if an error occurred

java.lang.IllegalArgumentException - if the parameter does not exist

See Also:

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

setInt

public void setInt(java.lang.String name,
                   int value)
            throws java.sql.SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

java.sql.SQLException - if an error occurred

java.lang.IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setInt(int, int)

setLong

public void setLong(java.lang.String name,
                    long value)
             throws java.sql.SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

java.sql.SQLException - if an error occurred

java.lang.IllegalArgumentException - if the parameter does not exist

See Also:

PreparedStatement.setInt(int, int)

setTimestamp

public void setTimestamp(java.lang.String name,
                         java.sql.Timestamp value)
                  throws java.sql.SQLException

Sets a parameter.

Parameters:

name - parameter name

value - parameter value

Throws:

java.sql.SQLException - if an error occurred

java.lang.IllegalArgumentException - if the parameter does not exist

See Also:

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

getStatement

public java.sql.PreparedStatement getStatement()

Returns the underlying statement.

Returns:

the statement

execute

public boolean execute()
                throws java.sql.SQLException

Executes the statement.

Returns:

true if the first result is a ResultSet

Throws:

java.sql.SQLException - if an error occurred

See Also:

PreparedStatement.execute()

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException

Executes the statement, which must be a query.

Returns:

the query results

Throws:

java.sql.SQLException - if an error occurred

See Also:

PreparedStatement.executeQuery()

executeUpdate

public int executeUpdate()
                  throws java.sql.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:

java.sql.SQLException - if an error occurred

See Also:

PreparedStatement.executeUpdate()

close

public void close()
           throws java.sql.SQLException

Closes the statement.

Throws:

java.sql.SQLException - if an error occurred

See Also:

Statement.close()

addBatch

public void addBatch()
              throws java.sql.SQLException

Adds the current set of parameters as a batch entry.

Throws:

java.sql.SQLException - if something went wrong

executeBatch

public int[] executeBatch()
                   throws java.sql.SQLException

Executes all of the batched statements. See Statement.executeBatch() for details.

Returns:

update counts for each statement

Throws:

java.sql.SQLException - if something went wrong