Sirius.server.sql

Class PreparableStatement

java.lang.Object

Sirius.server.sql.PreparableStatement

All Implemented Interfaces:

Serializable

public class PreparableStatement
extends Object
implements Serializable

NOT TO BE SHARED AMONG THREADS.

Version:

0.1

Author:

martin.scholl@cismet.de

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PreparableStatement(String stmt) Creates a new PreparableStatement object.
PreparableStatement(String stmt, int... types) Creates a new PreparableStatement object.

Method Summary

Modifier and Type	Method and Description
static PreparableStatement	fromString(String s) Not intended to do object deserialisation.
Object[]	getObjects() The actual values for the parameters.
String	getStatement() The statement.
int[]	getTypes() The types of the parameters of the statement, null if the types shall be inferred by the jdbc driver.
PreparedStatement	parameterise(Connection c) Creates a PreparedStatement using the parameterised statement, the types of this instance or the types of the jdbc driver if the types of this instance is null and the actual objects.
void	setObjects(Object... objects) Sets the actual objects that shall be used for parameterisation.
String	toString() This operation is only for debugging purposes.
static String	toString(PreparableStatement ps) Not intended to do object serialisation as the result will not contain any info of the available objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreparableStatement

public PreparableStatement(String stmt)

Creates a new PreparableStatement object. Similar to PreparableStatement(java.lang.String, int...) with null for types array.

Parameters:

stmt - the parameterised statement, not null

PreparableStatement

public PreparableStatement(String stmt,
                           int... types)

Creates a new PreparableStatement object. If null for the types array is provided then the parameterise operation will assume that the types are properly inferred by the jdbc driver.

Parameters:

stmt - the parameterised statement, not null

types - an int array with the types of the single parameters, sorted by occurrence in statement, or null if the types shall be inferred by the jdbc driver.

Throws:

IllegalArgumentException - if the stmt is null

Method Detail

getStatement

public String getStatement()

The statement.

Returns:

the statement

getTypes

public int[] getTypes()

The types of the parameters of the statement, null if the types shall be inferred by the jdbc driver.

Returns:

the types of the parameters of the statement

getObjects

public Object[] getObjects()

The actual values for the parameters.

Returns:

the actual values for the parameters

setObjects

public void setObjects(Object... objects)

Sets the actual objects that shall be used for parameterisation. The number of objects must match the number of types if the types are actually provided.

Parameters:

objects - the objects to use during parameterisation

Throws:

IllegalArgumentException - if objects is null or if the number of object does not match the number of types if the types are not null

parameterise

public PreparedStatement parameterise(Connection c)
                               throws SQLException

Creates a PreparedStatement using the parameterised statement, the types of this instance or the types of the jdbc driver if the types of this instance is null and the actual objects.

Parameters:

c - a jdbc connection to create the statement

Returns:

the parameterised PreparedStatement ready for execution

Throws:

SQLException - if there is an error during parameterisation

IllegalStateException - if the objects have not been set (objects are null)

toString

public String toString()

This operation is only for debugging purposes. It does not provide proper serialisation or anything similar.

Overrides:

toString in class Object

Returns:

a debug string representation of the instance

fromString

public static PreparableStatement fromString(String s)

Not intended to do object deserialisation. Builds a PreparableStatement from the given string. String is supposed to start with the statement followed by the parameter type numbers separated by ';'. If no parameter is given it is assumed that the statement does not have any parameters. If any of the parameters is the string 'null' (without quotes) then it is assumed that the types shall be collected from the database.

Parameters:

s - the string to parse

Returns:

a PreparableStatement with the appropriate settings

Throws:

IllegalStateException - DOCUMENT ME!

See Also:

PreparableStatement(java.lang.String, int...), toString(Sirius.server.sql.PreparableStatement)

toString

public static String toString(PreparableStatement ps)

Not intended to do object serialisation as the result will not contain any info of the available objects. Only builds a string that is compatible to fromString(java.lang.String).

Parameters:

ps - the object to convert to the string representation

Returns:

a string representation containing the statement and the type information