com.middlemindgames.tdb

Class StoredProcedure

java.lang.Object

com.middlemindgames.tdb.StoredProcedure

public class StoredProcedure
extends java.lang.Object

An extension of the JPanel class that holds extra information. Created by Andy Cunningham. Created on December 11, 2006, 10:00 AM

Constructor Summary

Constructors

Constructor and Description
StoredProcedure(DataAccess da) Create a new SQL Stored Procedure from a literal SQL query string.

Method Summary

Modifier and Type	Method and Description
void	addColumnParameter(java.lang.String columnName, java.lang.String value) Add a parameter to the list of parameters for this SQL command.
void	addParameter(java.lang.String columnName, int value) Add a parameter to the list of parameters for this SQL command.
void	addParameter(java.lang.String columnName, java.lang.String value) Add a parameter to the list of parameters for this SQL command.
void	clearParameters() Removes all parameters from the parameter list.
void	closeConnection() Closes the current database connection.
void	closeConnection(java.sql.ResultSet result) Closes the connection of the given ResultSet object.
java.sql.ResultSet	execute() Executes this stored procedure's SQL as if it would return a ResultSet.
int	executeNonQuery() Executes this stored procedure's SQL as if it would not return a ResultSet.
java.lang.String	getCommandText() Returns the current command text.
java.util.Hashtable	getParameters() Returns the parameters stored for this instance of StoredProcedure.
java.lang.String	getSql() Returns an SQL representation of the query.
void	setCommandText(java.lang.String cmdTxt) Set the Stored Procedure command text to a literal SQL command string.
void	setCommandText(java.lang.String cmdTxt, java.lang.String xmlDocument) Set the Stored Procedure command text to a SQL string stored in an XML configuration file.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoredProcedure

public StoredProcedure(DataAccess da)

Create a new SQL Stored Procedure from a literal SQL query string.

Parameters:

da - A data access class to help with the stored procedure execution.

Method Detail

getCommandText

public java.lang.String getCommandText()

Returns the current command text.

Returns:

A string representing the SQL command text.

setCommandText

public void setCommandText(java.lang.String cmdTxt)

Set the Stored Procedure command text to a literal SQL command string.

Parameters:

cmdTxt - A string representing the SQL command text.

setCommandText

public void setCommandText(java.lang.String cmdTxt,
                           java.lang.String xmlDocument)
                    throws java.lang.Exception

Set the Stored Procedure command text to a SQL string stored in an XML configuration file.

Parameters:

cmdTxt - The SQL command to run.

xmlDocument - The path of the XML file.

Throws:

java.lang.Exception - If the command type of this Stored Procedure is STRING, if the command could not be found in the XML doc, or if there is an XML parse error.

getParameters

public java.util.Hashtable getParameters()

Returns the parameters stored for this instance of StoredProcedure.

Returns:

Returns a Hashtable with the set parameters.

See Also:

Hashtable

addParameter

public void addParameter(java.lang.String columnName,
                         java.lang.String value)

Add a parameter to the list of parameters for this SQL command. Value undergoes the following manipulation: "'" + value.replaceAll("'", "") + "'"

Parameters:

columnName - The name of the coded parameter to replace, %SOME_NAME% or @SOME_NAME.

value - The value to replace an instance of the coded parameter with.

addColumnParameter

public void addColumnParameter(java.lang.String columnName,
                               java.lang.String value)

Add a parameter to the list of parameters for this SQL command. Value undergoes no manipulation.

Parameters:

columnName - The name of the coded parameter to replace, %SOME_NAME% or @SOME_NAME.

value - The value to replace an instance of the coded parameter with.

addParameter

public void addParameter(java.lang.String columnName,
                         int value)

Add a parameter to the list of parameters for this SQL command.

Parameters:

columnName - The name of the coded parameter to replace, %SOME_NAME% or @SOME_NAME.

value - An integer value to replace an instance of the coded parameter with.

clearParameters

public void clearParameters()

Removes all parameters from the parameter list.

getSql

public java.lang.String getSql()

Returns an SQL representation of the query.

Returns:

An SQL query.

execute

public java.sql.ResultSet execute()

Executes this stored procedure's SQL as if it would return a ResultSet.

Returns:

A JDBC ResultSet.

See Also:

ResultSet

executeNonQuery

public int executeNonQuery()

Executes this stored procedure's SQL as if it would not return a ResultSet.

Returns:

Returns the row count of changed records.

closeConnection

public void closeConnection()

Closes the current database connection.

closeConnection

public void closeConnection(java.sql.ResultSet result)

Closes the connection of the given ResultSet object.

Parameters:

result - A result set object to close connections for.