org.josef.jdbc

Class StoredProcedure

java.lang.Object

org.josef.jdbc.StoredProcedure

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Reviews(value=@Review(by="Kees Schotanus",at="2009-04-13"))
public final class StoredProcedure
extends Object

Utility class to execute stored procedures.

Version:

1.0 $Revision: 5814 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	callStoredProcedure(Connection connection, String name, StoredProcedureParameter... parameters) Calls a stored procedure using a Connection.
static Map<String,Object>	callStoredProcedure(DataSource dataSource, String name, StoredProcedureParameter... parameters) Calls a stored procedure using a DataSource.

Methods inherited from class java.lang.Object

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

Method Detail

callStoredProcedure

public static Map<String,Object> callStoredProcedure(DataSource dataSource,
                                                     String name,
                                                     StoredProcedureParameter... parameters)
                                              throws SQLException

Calls a stored procedure using a DataSource.
Assume you have the following stored procedure:

 CREATE PROCEDURE add(x in integer, y in integer, z out integer) IS
 BEGIN
    z:=x+y;
 END;
 

Then you would use code similar to this to call the stored procedure.

 final Map<String, Object> map = callStoredProcedure(dataSource, "add",
     new StoredProcedureParameter("x", CType.INTEGER, 70),
     new StoredProcedureParameter("y", CType.INTEGER, 10),
     new StoredProcedureParameter("z", OUT, CType.INTEGER));
 Integer result = (Integer)map.get("z");
 }

Parameters:

dataSource - DataSource used to get a connection from.

name - Name of the stored procedure.

parameters - The (optional) parameters.

Returns:

A Map where the key is the name of an StoredProcedureParameterType.INOUT or StoredProcedureParameterType.OUT parameter.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When either the supplied dataSource or the supplied name is null.

SQLException - When the statement could not be executed.

callStoredProcedure

public static Map<String,Object> callStoredProcedure(Connection connection,
                                                     String name,
                                                     StoredProcedureParameter... parameters)
                                              throws SQLException

Calls a stored procedure using a Connection.
Assume you have the following stored procedure:

 CREATE PROCEDURE add(x in integer, y in integer, z out integer) IS
 BEGIN
    z:=x+y;
 END;
 

Then you would use code similar to this to call the stored procedure.

 final Map<String, Object> map = callStoredProcedure(dataSource, "add",
     new StoredProcedureParameter("x", CType.INTEGER, 70),
     new StoredProcedureParameter("y", CType.INTEGER, 10),
     new StoredProcedureParameter("z", OUT, CType.INTEGER));
 Integer result = (Integer)map.get("z");
 }

Parameters:

connection - The database connection.

name - Name of the stored procedure.

parameters - The (optional) parameters.

Returns:

A Map where the key is the name of an StoredProcedureParameterType.INOUT or StoredProcedureParameterType.OUT parameter.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When either the supplied connection or name is null or when one of the supplied parameters is null.

SQLException - When the statement could not be executed.