Package com.identityworksllc.iiq.common.query

Class AbstractNamedParameterStatement<StatementType extends Statement>

java.lang.Object

com.identityworksllc.iiq.common.query.AbstractNamedParameterStatement<StatementType>

Type Parameters:

StatementType - The type of statement, PreparedStatement or CallableStatement

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

NamedParameterStatement

public abstract class AbstractNamedParameterStatement<StatementType extends Statement>
extends Object
implements AutoCloseable

The abstract superclass for the named parameter statement types.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowMissingAttributes	If true, invoking one of the setXXX methods on a non-existent parameter will be silently ignored.
protected Connection	connection	The connection
protected Map<String,int[]>	indexMap	Maps parameter names to arrays of ints which are the parameter indices.
protected StatementType	statement	The statement this object is wrapping.

Constructor Summary

Constructors

Constructor	Description
AbstractNamedParameterStatement()

Method Summary

Modifier and Type	Method	Description
abstract void	addBatch()	Adds an item to the current batch.
void	cancel()	Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
void	close()	Closes the statement.
int[]	executeBatch()	Executes all of the batched statements.
Connection	getConnection()	Returns the connection this statement is using.
ResultSet	getGeneratedKeys()	Returns any keys generated by the SQL statement.
protected int[]	getIndexes(String name)	Returns the indexes for a parameter.
boolean	getMoreResults()	Moves to this Statement object’s next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet.
boolean	getMoreResults(int current)	Moves to this Statement object’s next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.
Set<String>	getParameterNames()	Returns the set of parameter names.
ResultSet	getResultSet()	Returns the result set of the statement.
StatementType	getStatement()	Returns the underlying statement.
boolean	isClosed()	Returns true if the wrapped statement is closed
static String	parse(String query, Map<String,int[]> indexMap)	Parses a query with named parameters.
void	setAllowMissingAttributes(boolean allowMissingAttributes)	Sets the flag to allow an attempt to set missing attributes without throwing an exception.
void	setFetchDirection(int i)
void	setFetchSize(int i)
void	setMaxRows(int i)	Set the max rows in the result set
abstract void	setObject(String name, Object value)	Abstract method for use by subclasses to register their own specific value types
void	setParameters(Map<String,Object> parameters)	Sets all parameters to this named parameter statement in bulk from the given Map
void	setQueryTimeout(int seconds)	Sets the query timeout

Methods inherited from class java.lang.Object

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

Field Detail

allowMissingAttributes

protected boolean allowMissingAttributes

If true, invoking one of the setXXX methods on a non-existent parameter will be silently ignored.

The default is to throw an exception.

connection

protected Connection connection

The connection

indexMap

protected Map<String,int[]> indexMap

Maps parameter names to arrays of ints which are the parameter indices.

statement

protected StatementType extends Statement statement

The statement this object is wrapping.

Constructor Detail

AbstractNamedParameterStatement

public AbstractNamedParameterStatement()

Method Detail

parse

public static String parse(String query,
                           Map<String,int[]> indexMap)

Parses a query with named parameters.

The parameter-index mappings are put into the map, and the parsed query is returned.

Parameters:

query - query to parse

indexMap - map to hold parameter-index mappings

Returns:

the parsed query

addBatch

public abstract void addBatch()
                       throws SQLException

Adds an item to the current batch.

Oddly this is not implemented in Statement, but it is implemented by both sub-types of statement.

Throws:

SQLException - if an error occurred

See Also:

PreparedStatement.addBatch(), PreparedStatement.addBatch()

cancel

public void cancel()
            throws SQLException

Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.

Throws:

SQLException - if an error occurred

See Also:

Statement.cancel()

close

public void close()
           throws SQLException

Closes the statement.

Specified by:

close in interface AutoCloseable

Throws:

SQLException - if an error occurred

See Also:

Statement.close()

executeBatch

public int[] executeBatch()
                   throws SQLException

Executes all of the batched statements.

See Statement.executeBatch() and addBatch() for details.

Returns:

update counts for each statement

Throws:

SQLException - if something went wrong

See Also:

Statement.executeBatch()

getConnection

public Connection getConnection()
                         throws SQLException

Returns the connection this statement is using.

Returns:

the connection

Throws:

SQLException - if an error occurs while retrieving the connection

See Also:

Statement.getConnection()

getIndexes

protected int[] getIndexes(String name)

Returns the indexes for a parameter.

Parameters:

name - parameter name

Returns:

parameter indexes

Throws:

IllegalArgumentException - if the parameter does not exist

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException

Returns any keys generated by the SQL statement.

Returns:

A ResultSet containing the generated keys

Throws:

SQLException - if an error occurs while retrieving the keys

See Also:

Statement.getGeneratedKeys()

getMoreResults

public boolean getMoreResults()
                       throws SQLException

Moves to this Statement object’s next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet.

Returns:

True if the next result is a ResultSet object, false if there are no more results

Throws:

SQLException - if an error occurs while moving to the next result

getMoreResults

public boolean getMoreResults(int current)
                       throws SQLException

Moves to this Statement object’s next result, deals with any current ResultSet object(s) according to the instructions specified by the given flag, and returns true if the next result is a ResultSet object.

Parameters:

current - What to do with the current result set, a constant from Statement

Returns:

True if the next result is a ResultSet object, false if there are no more results

Throws:

SQLException - if an error occurs while moving to the next result

See Also:

Statement.getMoreResults(int), Statement.CLOSE_CURRENT_RESULT, Statement.KEEP_CURRENT_RESULT, Statement.CLOSE_ALL_RESULTS

getParameterNames

public Set<String> getParameterNames()

Returns the set of parameter names.

Returns:

An unmodifiable set of parameter names

getResultSet

public ResultSet getResultSet()
                       throws SQLException

Returns the result set of the statement.

Returns:

the result set

Throws:

SQLException - if an error occurs while retrieving the result set

See Also:

Statement.getResultSet()

getStatement

public StatementType getStatement()

Returns the underlying statement.

Returns:

the statement

isClosed

public boolean isClosed()
                 throws SQLException

Returns true if the wrapped statement is closed

Returns:

True if the wrapped statement is closed

Throws:

SQLException

See Also:

Statement.isClosed()

setAllowMissingAttributes

public void setAllowMissingAttributes(boolean allowMissingAttributes)

Sets the flag to allow an attempt to set missing attributes without throwing an exception.

With this flag set to false, any attempt to invoke setString, or any other setXYZ method, will result in an exception.

Parameters:

allowMissingAttributes - true if we should not throw an exception when a parameter is unused

setFetchDirection

public void setFetchDirection(int i)
                       throws SQLException

Throws:

SQLException

See Also:

Statement.setFetchDirection(int)

setFetchSize

public void setFetchSize(int i)
                  throws SQLException

Throws:

SQLException

See Also:

Statement.setFetchSize(int)

setMaxRows

public void setMaxRows(int i)
                throws SQLException

Set the max rows in the result set

Parameters:

i - The result row size

Throws:

SQLException - on errors

setObject

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

Abstract method for use by subclasses to register their own specific value types

Parameters:

name - The name of the argument to set

value - The value to set

Throws:

SQLException - if any errors occur

setParameters

public final void setParameters(Map<String,Object> parameters)
                         throws SQLException

Sets all parameters to this named parameter statement in bulk from the given Map

Parameters:

parameters - The parameters in question

Throws:

SQLException - if any failures occur

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws SQLException

Sets the query timeout

Parameters:

seconds - The timeout for this query in seconds

Throws:

SQLException - if any errors occur

See Also:

Statement.setQueryTimeout(int)