com.ziclix.python.sql

Class Procedure

java.lang.Object

com.ziclix.python.sql.Procedure

Direct Known Subclasses:

SQLServerProcedure

public class Procedure
extends java.lang.Object

This class provides the necessary functionality to call stored procedures. It handles managing the database metadata and binding the appropriate parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	COLUMN_TYPE Field COLUMN_TYPE
protected PyObject	columns Field columns
protected PyCursor	cursor Field cursor
protected static int	DATA_TYPE Field DATA_TYPE
protected static int	DATA_TYPE_NAME Field DATA_TYPE_NAME
protected java.util.BitSet	inputSet Field inputSet
protected static int	LENGTH Field LENGTH
protected static int	NAME Field NAME
protected static int	NULLABLE Field NULLABLE
protected static int	PRECISION Field PRECISION
protected PyObject	procedureCatalog Field procedureCatalog
protected PyObject	procedureName Field procedureName
protected PyObject	procedureSchema Field procedureSchema
protected static int	SCALE Field SCALE

Constructor Summary

Constructors

Constructor and Description
Procedure(PyCursor cursor, PyObject name) Constructor Procedure

Method Summary

Modifier and Type	Method and Description
protected void	fetchColumns() Get the columns for the stored procedure.
protected PyObject	getDefault() The value for a missing schema or catalog.
protected java.lang.String	getProcedureName() Construct a procedure name for the relevant schema and catalog information.
boolean	isInput(int index) This method determines whether the param at the specified index is an IN or INOUT param for a stored procedure.
void	normalizeInput(PyObject params, PyObject bindings) Prepare the binding dictionary with the correct datatypes.
java.sql.CallableStatement	prepareCall() Prepares the statement and registers the OUT/INOUT parameters (if any).
java.sql.CallableStatement	prepareCall(PyObject rsType, PyObject rsConcur) Prepares the statement and registers the OUT/INOUT parameters (if any).
protected void	registerOutParameters(java.sql.CallableStatement statement) Registers the OUT/INOUT parameters of the statement.
java.lang.String	toSql() Returns the call in the syntax:

Methods inherited from class java.lang.Object

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

Field Detail

NAME

protected static final int NAME

Field NAME

See Also:

Constant Field Values

COLUMN_TYPE

protected static final int COLUMN_TYPE

Field COLUMN_TYPE

See Also:

Constant Field Values

DATA_TYPE

protected static final int DATA_TYPE

Field DATA_TYPE

See Also:

Constant Field Values

DATA_TYPE_NAME

protected static final int DATA_TYPE_NAME

Field DATA_TYPE_NAME

See Also:

Constant Field Values

PRECISION

protected static final int PRECISION

Field PRECISION

See Also:

Constant Field Values

LENGTH

protected static final int LENGTH

Field LENGTH

See Also:

Constant Field Values

SCALE

protected static final int SCALE

Field SCALE

See Also:

Constant Field Values

NULLABLE

protected static final int NULLABLE

Field NULLABLE

See Also:

Constant Field Values

cursor

protected PyCursor cursor

Field cursor

columns

protected PyObject columns

Field columns

procedureCatalog

protected PyObject procedureCatalog

Field procedureCatalog

procedureSchema

protected PyObject procedureSchema

Field procedureSchema

procedureName

protected PyObject procedureName

Field procedureName

inputSet

protected java.util.BitSet inputSet

Field inputSet

Constructor Detail

Procedure

public Procedure(PyCursor cursor,
                 PyObject name)
          throws java.sql.SQLException

Constructor Procedure

Parameters:

cursor - cursor an open cursor

name - name a string or tuple representing the name

Throws:

java.sql.SQLException

Method Detail

prepareCall

public java.sql.CallableStatement prepareCall()
                                       throws java.sql.SQLException

Prepares the statement and registers the OUT/INOUT parameters (if any).

Returns:

CallableStatement

Throws:

java.sql.SQLException

prepareCall

public java.sql.CallableStatement prepareCall(PyObject rsType,
                                              PyObject rsConcur)
                                       throws java.sql.SQLException

Prepares the statement and registers the OUT/INOUT parameters (if any).

Parameters:

rsType - the value of to be created ResultSet type

rsConcur - the value of the to be created ResultSet concurrency

Returns:

CallableStatement

Throws:

java.sql.SQLException

normalizeInput

public void normalizeInput(PyObject params,
                           PyObject bindings)
                    throws java.sql.SQLException

Prepare the binding dictionary with the correct datatypes.

Parameters:

params - a non-None list of params

bindings - a dictionary of bindings

Throws:

java.sql.SQLException

isInput

public boolean isInput(int index)
                throws java.sql.SQLException

This method determines whether the param at the specified index is an IN or INOUT param for a stored procedure. This is only configured properly AFTER a call to normalizeInput().

Parameters:

index - JDBC indexed column index (1, 2, ...)

Returns:

true if the column is an input, false otherwise

Throws:

java.sql.SQLException

toSql

public java.lang.String toSql()
                       throws java.sql.SQLException

Returns the call in the syntax:

 {? = call <procedure-name>(?, ?, ...)}
 {call <procedure-name>(?, ?, ...)}
 

As of now, all parameters variables are created and no support for named variable calling is supported.

Returns:

String

Throws:

java.sql.SQLException

registerOutParameters

protected void registerOutParameters(java.sql.CallableStatement statement)
                              throws java.sql.SQLException

Registers the OUT/INOUT parameters of the statement.

Parameters:

statement - statement

Throws:

java.sql.SQLException

fetchColumns

protected void fetchColumns()
                     throws java.sql.SQLException

Get the columns for the stored procedure.

Throws:

java.sql.SQLException

getDefault

protected PyObject getDefault()

The value for a missing schema or catalog. This value is used to find the column names for the procedure. Not all DBMS use the same default value; for instance Oracle uses an empty string and SQLServer a null. This implementation returns the empty string.

Returns:

the default value (the empty string)

See Also:

DatabaseMetaData.getProcedureColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getProcedureName

protected java.lang.String getProcedureName()

Construct a procedure name for the relevant schema and catalog information.