Package org.smyld.db

Class Utility

java.lang.Object

org.smyld.db.Utility

Direct Known Subclasses:

OracleDBUtil

public class Utility
extends java.lang.Object

To facilitate the use of JDBC classes and methods and strengthen the sql statements fetch and update operations

Version:

1.0 03/03/03

Author:

Mohammed Jamil

Field Summary

Fields

Modifier and Type	Field	Description
protected java.sql.Connection	dbConnection	Represents the connection object that is used by the class to execute SQL statements
static int	ERR_CATEGORY_CONNECTION
static int	ERR_CATEGORY_SQL
static int	ERR_CATEGORY_STORED_PROCEDURES_ERROR
static int	ERR_CATEGORY_STORED_PROCEDURES_RECOMPILED
static int	EXCEPTION_CONNECTION_RESET
static int	EXCEPTION_CONNECTION_SHUT
protected DBErrorHandler	handler	Handles the errors regarding this connection
protected DBIOHandler	ioHandler
protected DBConnection	smyldDbConnection

Constructor Summary

Constructors

Constructor	Description
Utility(DBConnection activeDBConnection, DBErrorHandler e)	Constructs the class with the given connection object to be used for the execution of statements

Method Summary

Modifier and Type	Method	Description
void	closeCursor(java.sql.PreparedStatement stRecords)	Close the cursor opened through the given prepared statement object
void	closeCursor(java.sql.ResultSet rsRecords)	Close the cursor opened through the given result set object
static java.lang.String	constructDoubleParamFunctionCall(java.lang.String functionName)
static java.lang.String	constructDoubleParamProcedureCall(java.lang.String ProcedureName)
static java.lang.String	constructMultiParamFunctionCall(java.lang.String functionName, int paramsNo)
static java.lang.String	constructMultiParamProcedureCall(java.lang.String ProcedureName, int paramsNo)
static java.lang.String	constructSingleParamFunctionCall(java.lang.String functionName)
static java.lang.String	constructSingleParamProcedureCall(java.lang.String ProcedureName)
static java.lang.String	constructTrippleParamFunctionCall(java.lang.String functionName)
static java.lang.String	constructTrippleParamProcedureCall(java.lang.String ProcedureName)
java.lang.String	createInsertSQL(java.lang.String tableName)
java.lang.String	detectLongFieldError(java.sql.PreparedStatement st)
boolean	doDoubleParamSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String sqlText)	To invoke the given sql and set the given 2 parameters using execute method
int	doDoubleParamUpdateSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String sqlText)	To invoke the given sql and set the given 2 parameters using executeUpdate method
int	doQuadParamUpdateSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String thirdParam, java.lang.String fourthParam, java.lang.String sqlText)	To invoke the given sql and set the given 3 parameters using executeUpdate method
boolean	doSingleParamSQL(int firstParam, java.lang.String sqlText)	To invoke the given sql and set the given integer parameter using execute method
boolean	doSingleParamSQL(java.lang.String firstParam, java.lang.String sqlText)	To invoke the given sql and set the given string parameter using execute method
int	doSingleParamUpdateSQL(java.lang.String firstParam, java.lang.String sqlText)	To invoke the given sql and set the given string parameter using executeUpdate method and returns the affected records number
int	doTrippleParamUpdateSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String thirdParam, java.lang.String sqlText)	To invoke the given sql and set the given 3 parameters using executeUpdate method
void	executeDoubleParamFunction(java.lang.String function, int param1, int param2)
void	executeDoubleParamFunction(java.lang.String function, java.lang.String param1, java.lang.String param2)
void	executeDoubleParamProcedure(java.lang.String procedure, int param1, int param2)
void	executeDoubleParamProcedure(java.lang.String procedure, java.lang.String param1, java.lang.String param2)
void	executeMultiParamProcedure(java.lang.String procedure, java.lang.String[] params)
java.sql.ResultSet	executeQuery(java.lang.String sqlText)	To invoke the given sql using executeQuery method
void	executeTrippleParamFunction(java.lang.String function, java.lang.String param1, java.lang.String param2, java.lang.String param3)
void	executeTrippleParamProcedure(java.lang.String procedure, java.lang.String param1, int param2, int param3)
java.sql.ResultSet	fetchTableData(java.lang.String tableName)	Fetches the all the records of the given table with out any conditions
java.util.HashMap<java.lang.String,Field>	FetchTableFields(java.lang.String TableName, java.lang.String FieldName, java.lang.String FieldValue)	Fetchs the given table name data and returns HashMap object containing org.smyld.db.Field objects created upon the given field Name/Value pair (represents 2 column names in the given table name)
void	FillColumnNames(java.sql.ResultSetMetaData rsMetaData, java.util.HashMap<java.lang.String,java.lang.Integer> results)
java.sql.Connection	getConnection()
int	getCount(java.sql.ResultSet rs)
java.sql.ResultSet	getDoubleParamSQL(int firstParam, int secondParam, java.lang.String sqlText)	To invoke the given sql using executeQuery method,setting the given 2 parameter and returning the resultant result set
java.sql.ResultSet	getDoubleParamSQL(int firstParam, java.lang.String secondParam, java.lang.String sqlText)	To invoke the given sql using executeQuery method,setting the given 2 parameter and returning the resultant result set
java.sql.ResultSet	getDoubleParamSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String sqlText)	To invoke the given sql using executeQuery method,setting the given 2 parameter and returning the resultant result set
static int	getErrorCategory(java.lang.Exception ex)
protected static java.lang.String	getParamsText(int paramsNo)
java.sql.ResultSet	getQuadParamSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String thirdParam, java.lang.String fourthParam, java.lang.String sqlText)
int	getSequenceValue(java.lang.String seqName)
int	getSequentialID(java.lang.String tableName, java.lang.String idColName)	Calculate the value of the given column name in the given table and increase it by one.
int	getSequentialID(java.lang.String tableName, java.lang.String idColName, java.lang.String whereColumnName, java.lang.String whereColumnValue)	Calculate the value of the given column name in the given table and increase it by one.
java.sql.ResultSet	getSingleParamSQL(java.lang.String paramValue, java.lang.String sqlText)	To invoke the given sql using executeQuery method,setting the given parameter and returning the resultant result set
java.lang.String	getSingleParamSQLData(java.lang.String firstParam, java.lang.String sqlText, java.lang.String columnName)	To invoke the given sql using class getSingleParamSQL method,setting the given parameter and returning the gievn column name value
java.lang.String	getSQLData(java.lang.String sqlText, java.lang.String columnName)	To invoke the given sql using class executeQuery method, and returning the gievn column name value
java.sql.ResultSet	getSQLResultSet(java.lang.String sqlText)
static java.lang.String	getStringIndex(int digitWidth, int index)	Returns the index represented as the required number of digit text.
java.util.Vector<TableColumn>	getTableCols(java.lang.String tableName)
java.sql.ResultSet	getTrippleParamSQL(int firstParam, int secondParam, java.lang.String thirdParam, java.lang.String sqlText)	To invoke the given sql and set the given 3 parameters using executeQuery method and returns the resultant result set
java.sql.ResultSet	getTrippleParamSQL(java.lang.String firstParam, java.lang.String secondParam, java.lang.String thirdParam, java.lang.String sqlText)	To invoke the given sql and set the given 3 parameters using executeQuery method and returns the resultant result set
void	handleDBError(java.lang.Exception ex)
void	importFile(java.lang.String targetTable, java.lang.String fileName)
boolean	isDoubleExist(java.lang.String firstParam, java.lang.String secondParam, java.lang.String sqlText)	Checking if the given double parameter sql statement contains records or not
boolean	isExist(java.lang.String sqlText)	Checking if the given single parameter sql statement contains records or not
boolean	isExist(java.sql.ResultSet rsRecords)	Checking if the given result set contains records or not
boolean	isSingleExist(java.lang.String firstParam, java.lang.String sqlText)	Checking if the given single parameter sql statement contains records or not
boolean	isTrippleExist(java.lang.String firstParam, java.lang.String secondParam, java.lang.String thirdParam, java.lang.String sqlText)	Checking if the given tripple parameter sql statement contains records or not
void	setSMYLDConnection(DBConnection activeConnection)

Methods inherited from class java.lang.Object

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

Field Detail

dbConnection

protected java.sql.Connection dbConnection

Represents the connection object that is used by the class to execute SQL statements

smyldDbConnection

protected DBConnection smyldDbConnection

ioHandler

protected DBIOHandler ioHandler

handler

protected DBErrorHandler handler

Handles the errors regarding this connection

ERR_CATEGORY_SQL

public static final int ERR_CATEGORY_SQL

See Also:

Constant Field Values

ERR_CATEGORY_CONNECTION

public static final int ERR_CATEGORY_CONNECTION

See Also:

Constant Field Values

ERR_CATEGORY_STORED_PROCEDURES_RECOMPILED

public static final int ERR_CATEGORY_STORED_PROCEDURES_RECOMPILED

See Also:

Constant Field Values

ERR_CATEGORY_STORED_PROCEDURES_ERROR

public static final int ERR_CATEGORY_STORED_PROCEDURES_ERROR

See Also:

Constant Field Values

EXCEPTION_CONNECTION_RESET

public static final int EXCEPTION_CONNECTION_RESET

See Also:

Constant Field Values

EXCEPTION_CONNECTION_SHUT

public static final int EXCEPTION_CONNECTION_SHUT

See Also:

Constant Field Values

Constructor Detail

Utility

public Utility(DBConnection activeDBConnection,
               DBErrorHandler e)

Constructs the class with the given connection object to be used for the execution of statements

Parameters:

activeConnection - the active data base connection object

e - the error handler object that takes care of the errors raised during this connection

Method Detail

closeCursor

public void closeCursor(java.sql.ResultSet rsRecords)

Close the cursor opened through the given result set object

Parameters:

rsRecords - the result set of the opened cursor

closeCursor

public void closeCursor(java.sql.PreparedStatement stRecords)

Close the cursor opened through the given prepared statement object

Parameters:

stRecords - the prepared statement of the opened cursor

doDoubleParamSQL

public boolean doDoubleParamSQL(java.lang.String firstParam,
                                java.lang.String secondParam,
                                java.lang.String sqlText)

To invoke the given sql and set the given 2 parameters using execute method

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

sqlText - the SQL statement

Returns:

true if the operation succeded false otherwise

setSMYLDConnection

public void setSMYLDConnection(DBConnection activeConnection)

doDoubleParamUpdateSQL

public int doDoubleParamUpdateSQL(java.lang.String firstParam,
                                  java.lang.String secondParam,
                                  java.lang.String sqlText)

To invoke the given sql and set the given 2 parameters using executeUpdate method

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

sqlText - the SQL statement

Returns:

>0 means the number of affected records in data base after executing the statement or 0 if nothing returned

doSingleParamSQL

public boolean doSingleParamSQL(int firstParam,
                                java.lang.String sqlText)

To invoke the given sql and set the given integer parameter using execute method

Parameters:

firstParam - the first parameter value

sqlText - the SQL statement

Returns:

true if the operation succeded false otherwise

detectLongFieldError

public java.lang.String detectLongFieldError(java.sql.PreparedStatement st)
                                      throws java.sql.SQLException

Throws:

java.sql.SQLException

doTrippleParamUpdateSQL

public int doTrippleParamUpdateSQL(java.lang.String firstParam,
                                   java.lang.String secondParam,
                                   java.lang.String thirdParam,
                                   java.lang.String sqlText)

To invoke the given sql and set the given 3 parameters using executeUpdate method

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

thirdParam - the third parameter value

sqlText - the SQL statement

Returns:

>0 means the number of affected records in data base after executing the statement or 0 if nothing returned

doQuadParamUpdateSQL

public int doQuadParamUpdateSQL(java.lang.String firstParam,
                                java.lang.String secondParam,
                                java.lang.String thirdParam,
                                java.lang.String fourthParam,
                                java.lang.String sqlText)

To invoke the given sql and set the given 3 parameters using executeUpdate method

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

thirdParam - the third parameter value

sqlText - the SQL statement

Returns:

>0 means the number of affected records in data base after executing the statement or 0 if nothing returned

getTrippleParamSQL

public java.sql.ResultSet getTrippleParamSQL(java.lang.String firstParam,
                                             java.lang.String secondParam,
                                             java.lang.String thirdParam,
                                             java.lang.String sqlText)

To invoke the given sql and set the given 3 parameters using executeQuery method and returns the resultant result set

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

thirdParam - the third parameter value

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

getQuadParamSQL

public java.sql.ResultSet getQuadParamSQL(java.lang.String firstParam,
                                          java.lang.String secondParam,
                                          java.lang.String thirdParam,
                                          java.lang.String fourthParam,
                                          java.lang.String sqlText)

getTrippleParamSQL

public java.sql.ResultSet getTrippleParamSQL(int firstParam,
                                             int secondParam,
                                             java.lang.String thirdParam,
                                             java.lang.String sqlText)

To invoke the given sql and set the given 3 parameters using executeQuery method and returns the resultant result set

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

thirdParam - the third parameter value

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

doSingleParamUpdateSQL

public int doSingleParamUpdateSQL(java.lang.String firstParam,
                                  java.lang.String sqlText)

To invoke the given sql and set the given string parameter using executeUpdate method and returns the affected records number

Parameters:

firstParam - the first parameter value

sqlText - the SQL statement

Returns:

>0 means the number of affected records in data base after executing the statement or 0 if nothing returned

doSingleParamSQL

public boolean doSingleParamSQL(java.lang.String firstParam,
                                java.lang.String sqlText)

To invoke the given sql and set the given string parameter using execute method

Parameters:

firstParam - the first parameter value

sqlText - the SQL statement

Returns:

true if the operation succeded false otherwise

executeQuery

public java.sql.ResultSet executeQuery(java.lang.String sqlText)

To invoke the given sql using executeQuery method

Parameters:

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

getSQLData

public java.lang.String getSQLData(java.lang.String sqlText,
                                   java.lang.String columnName)

To invoke the given sql using class executeQuery method, and returning the gievn column name value

Parameters:

sqlText - the SQL statement

columnName - the column name of the desired column value

Returns:

The column value if succeded and null otherwise

getSingleParamSQLData

public java.lang.String getSingleParamSQLData(java.lang.String firstParam,
                                              java.lang.String sqlText,
                                              java.lang.String columnName)

To invoke the given sql using class getSingleParamSQL method,setting the given parameter and returning the gievn column name value

Parameters:

firstParam - the first parameter value

sqlText - the SQL statement

columnName - the column name of the desired column value

Returns:

The column value if succeded and null otherwise

getCount

public int getCount(java.sql.ResultSet rs)

getSingleParamSQL

public java.sql.ResultSet getSingleParamSQL(java.lang.String paramValue,
                                            java.lang.String sqlText)

To invoke the given sql using executeQuery method,setting the given parameter and returning the resultant result set

Parameters:

firstParam - the first parameter value

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

getSQLResultSet

public java.sql.ResultSet getSQLResultSet(java.lang.String sqlText)

getDoubleParamSQL

public java.sql.ResultSet getDoubleParamSQL(java.lang.String firstParam,
                                            java.lang.String secondParam,
                                            java.lang.String sqlText)

To invoke the given sql using executeQuery method,setting the given 2 parameter and returning the resultant result set

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

getDoubleParamSQL

public java.sql.ResultSet getDoubleParamSQL(int firstParam,
                                            java.lang.String secondParam,
                                            java.lang.String sqlText)

To invoke the given sql using executeQuery method,setting the given 2 parameter and returning the resultant result set

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

getDoubleParamSQL

public java.sql.ResultSet getDoubleParamSQL(int firstParam,
                                            int secondParam,
                                            java.lang.String sqlText)

To invoke the given sql using executeQuery method,setting the given 2 parameter and returning the resultant result set

Parameters:

firstParam - the first parameter value

secondParam - the second parameter value

sqlText - the SQL statement

Returns:

The resultant result set if succeded and null otherwise

getSequentialID

public int getSequentialID(java.lang.String tableName,
                           java.lang.String idColName)

Calculate the value of the given column name in the given table and increase it by one. To use it for the increased records counter columns

Parameters:

tableName - required table name

Returns:

the resultant column value if succeded and -1 otherwise

getSequentialID

public int getSequentialID(java.lang.String tableName,
                           java.lang.String idColName,
                           java.lang.String whereColumnName,
                           java.lang.String whereColumnValue)

Calculate the value of the given column name in the given table and increase it by one. To use it for the increased records counter columns

Parameters:

tableName - required table name

Returns:

the resultant column value if succeded and -1 otherwise

getSequenceValue

public int getSequenceValue(java.lang.String seqName)

isExist

public boolean isExist(java.sql.ResultSet rsRecords)

Checking if the given result set contains records or not

Parameters:

rsRecords - The result set to be checked

Returns:

true if it contains at least one record and false otherwise

isSingleExist

public boolean isSingleExist(java.lang.String firstParam,
                             java.lang.String sqlText)

Checking if the given single parameter sql statement contains records or not

Parameters:

firstParam - The first parameter value

sqlText - The SQL text

Returns:

true if it contains at least one record and false otherwise

isExist

public boolean isExist(java.lang.String sqlText)

Checking if the given single parameter sql statement contains records or not

Parameters:

firstParam - The first parameter value

sqlText - The SQL text

Returns:

true if it contains at least one record and false otherwise

isDoubleExist

public boolean isDoubleExist(java.lang.String firstParam,
                             java.lang.String secondParam,
                             java.lang.String sqlText)

Checking if the given double parameter sql statement contains records or not

Parameters:

firstParam - The first parameter value

secondParam - The second parameter value

sqlText - The SQL text

Returns:

true if it contains at least one record and false otherwise

isTrippleExist

public boolean isTrippleExist(java.lang.String firstParam,
                              java.lang.String secondParam,
                              java.lang.String thirdParam,
                              java.lang.String sqlText)

Checking if the given tripple parameter sql statement contains records or not

Parameters:

firstParam - The first parameter value

secondParam - The second parameter value

thirdParam - The third parameter value

sqlText - The SQL text

Returns:

true if it contains at least one record and false otherwise

fetchTableData

public java.sql.ResultSet fetchTableData(java.lang.String tableName)

Fetches the all the records of the given table with out any conditions

Parameters:

tableName - comments

Returns:

The resultant result set and null if any error happened

FetchTableFields

public java.util.HashMap<java.lang.String,Field> FetchTableFields(java.lang.String TableName,
                                                                  java.lang.String FieldName,
                                                                  java.lang.String FieldValue)

Fetchs the given table name data and returns HashMap object containing org.smyld.db.Field objects created upon the given field Name/Value pair (represents 2 column names in the given table name)

Parameters:

TableName - the target table of data

FieldName - the target table column representing the field Name

FieldValue - the target table column representing the field Value

Returns:

returns HashMap object of org.smyld.db.Field type, holding the information of the table records or null in case of any error

FillColumnNames

public void FillColumnNames(java.sql.ResultSetMetaData rsMetaData,
                            java.util.HashMap<java.lang.String,java.lang.Integer> results)

getStringIndex

public static java.lang.String getStringIndex(int digitWidth,
                                              int index)

Returns the index represented as the required number of digit text. For example index with the value of 5 and a digitWidth of 3 means "005" and so on

Parameters:

digitWidth - the width of the required digits

Returns:

the index represented as the 3 digit text

handleDBError

public void handleDBError(java.lang.Exception ex)

constructSingleParamProcedureCall

public static java.lang.String constructSingleParamProcedureCall(java.lang.String ProcedureName)

constructDoubleParamProcedureCall

public static java.lang.String constructDoubleParamProcedureCall(java.lang.String ProcedureName)

constructTrippleParamProcedureCall

public static java.lang.String constructTrippleParamProcedureCall(java.lang.String ProcedureName)

constructSingleParamFunctionCall

public static java.lang.String constructSingleParamFunctionCall(java.lang.String functionName)

constructDoubleParamFunctionCall

public static java.lang.String constructDoubleParamFunctionCall(java.lang.String functionName)

constructTrippleParamFunctionCall

public static java.lang.String constructTrippleParamFunctionCall(java.lang.String functionName)

constructMultiParamFunctionCall

public static java.lang.String constructMultiParamFunctionCall(java.lang.String functionName,
                                                               int paramsNo)

constructMultiParamProcedureCall

public static java.lang.String constructMultiParamProcedureCall(java.lang.String ProcedureName,
                                                                int paramsNo)

getParamsText

protected static java.lang.String getParamsText(int paramsNo)

executeDoubleParamFunction

public void executeDoubleParamFunction(java.lang.String function,
                                       java.lang.String param1,
                                       java.lang.String param2)

executeTrippleParamFunction

public void executeTrippleParamFunction(java.lang.String function,
                                        java.lang.String param1,
                                        java.lang.String param2,
                                        java.lang.String param3)

executeDoubleParamFunction

public void executeDoubleParamFunction(java.lang.String function,
                                       int param1,
                                       int param2)

executeMultiParamProcedure

public void executeMultiParamProcedure(java.lang.String procedure,
                                       java.lang.String[] params)

executeDoubleParamProcedure

public void executeDoubleParamProcedure(java.lang.String procedure,
                                        int param1,
                                        int param2)

executeDoubleParamProcedure

public void executeDoubleParamProcedure(java.lang.String procedure,
                                        java.lang.String param1,
                                        java.lang.String param2)

executeTrippleParamProcedure

public void executeTrippleParamProcedure(java.lang.String procedure,
                                         java.lang.String param1,
                                         int param2,
                                         int param3)

getConnection

public java.sql.Connection getConnection()

importFile

public void importFile(java.lang.String targetTable,
                       java.lang.String fileName)
                throws java.lang.Exception

Throws:

java.lang.Exception

getErrorCategory

public static int getErrorCategory(java.lang.Exception ex)

createInsertSQL

public java.lang.String createInsertSQL(java.lang.String tableName)
                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getTableCols

public java.util.Vector<TableColumn> getTableCols(java.lang.String tableName)
                                           throws java.sql.SQLException

Throws:

java.sql.SQLException