org.safs

Class DatabaseCommandsHelper

java.lang.Object

org.safs.DatabaseCommandsHelper

public class DatabaseCommandsHelper
extends java.lang.Object

Purpose: DatabaseCommandsHelper, used by DCDriverCommands.
Lifetime: static methods

Since:

Oct 27, 2003
Nov 05, 2003 (DBauman) Original Release

Author:

Doug Bauman

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYDBTABLECOLUMNTOFILE
static java.lang.String	COPYDBTABLETOFILE
static java.lang.String	DELETEDBTABLERECORDS
static java.lang.String	EXECSQLCOMMIT
static java.lang.String	EXECSQLQUERY
static java.lang.String	GETDBTABLECOLUMNCOUNT
static java.lang.String	GETDBTABLEROWCOUNT
static java.lang.String	GETDBVALUE
protected static java.sql.Connection	lastConn
protected static java.lang.String	lastConnPass
protected static java.lang.String	lastConnUrl
protected static java.lang.String	lastConnUser
static java.lang.String	SETJDBCDRIVER
static java.lang.String	VERIFYDATABASENULLVALUE
static java.lang.String	VERIFYDATABASEVALUE
static java.lang.String	VERIFYDBNULLVALUE
static java.lang.String	VERIFYDBVALUE

Constructor Summary

Constructors

Constructor and Description
DatabaseCommandsHelper()

Method Summary

Modifier and Type	Method and Description
static void	copyDBTableColumnToFile(Processor pr) Purpose: copyDBTableColumnToFile
static void	copyDBTableToFile(Processor pr) Purpose: copyDBTableToFile
static void	deleteDBTableRecords(Processor pr) Purpose: deleteDBTableRecords Deletes records in a database table 0.
static boolean	equalsDatabaseCommand(java.lang.String command)
static void	execSQLCommit(Processor pr) Purpose: execSqlCommit Commits the pending queries on the database.
static void	execSQLQuery(Processor pr) Purpose: execSQLQuery Executes the query provided in a queryStr on the database table.
protected static java.sql.Connection	getConnection(java.lang.String url, java.lang.String user, java.lang.String pass) Purpose: getConnection; does this first: if (loadedDriver == null) loadDriver(null); then opens the connection
static void	getDBTableColumnCount(Processor pr) Purpose: getDBTableColumnCount Executes 'select * from table' and returns the total column count.
static void	getDBTableRowCount(Processor pr) Purpose: getDBTableRowCount Executes 'select * from table' and returns the total row count.
static void	getDBValue(Processor pr) Purpose: getDBValue getAlternateParams: 0.
protected static java.lang.Class	loadDriver(java.lang.String driver) Purpose: load driver
static void	setJdbcDriver(Processor pr) Purpose: setJdbcDriver
static void	verifyDatabaseNullValue(Processor pr) Purpose: verifyDatabaseNullValue Verifies that the value of a field in a database table is NULL.
static void	verifyDatabaseValue(Processor pr) Purpose: verifyDatabaseValue: Verifies the case-sensitive value of a field in a database table.
static void	verifyDBNullValue(Processor pr) Purpose: verifyDBNullValue: same as verifyDatabaseNullValue
static void	verifyDBValue(Processor pr) Purpose: verifyDBValue: same as verifyDatabaseValue

Methods inherited from class java.lang.Object

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

Field Detail

SETJDBCDRIVER

public static final java.lang.String SETJDBCDRIVER

See Also:

Constant Field Values

COPYDBTABLECOLUMNTOFILE

public static final java.lang.String COPYDBTABLECOLUMNTOFILE

See Also:

Constant Field Values

COPYDBTABLETOFILE

public static final java.lang.String COPYDBTABLETOFILE

See Also:

Constant Field Values

DELETEDBTABLERECORDS

public static final java.lang.String DELETEDBTABLERECORDS

See Also:

Constant Field Values

EXECSQLQUERY

public static final java.lang.String EXECSQLQUERY

See Also:

Constant Field Values

EXECSQLCOMMIT

public static final java.lang.String EXECSQLCOMMIT

See Also:

Constant Field Values

GETDBTABLECOLUMNCOUNT

public static final java.lang.String GETDBTABLECOLUMNCOUNT

See Also:

Constant Field Values

GETDBTABLEROWCOUNT

public static final java.lang.String GETDBTABLEROWCOUNT

See Also:

Constant Field Values

GETDBVALUE

public static final java.lang.String GETDBVALUE

See Also:

Constant Field Values

VERIFYDATABASENULLVALUE

public static final java.lang.String VERIFYDATABASENULLVALUE

See Also:

Constant Field Values

VERIFYDATABASEVALUE

public static final java.lang.String VERIFYDATABASEVALUE

See Also:

Constant Field Values

VERIFYDBNULLVALUE

public static final java.lang.String VERIFYDBNULLVALUE

See Also:

Constant Field Values

VERIFYDBVALUE

public static final java.lang.String VERIFYDBVALUE

See Also:

Constant Field Values

lastConnUrl

protected static java.lang.String lastConnUrl

lastConnUser

protected static java.lang.String lastConnUser

lastConnPass

protected static java.lang.String lastConnPass

lastConn

protected static java.sql.Connection lastConn

Constructor Detail

DatabaseCommandsHelper

public DatabaseCommandsHelper()

Method Detail

equalsDatabaseCommand

public static boolean equalsDatabaseCommand(java.lang.String command)

getConnection

protected static java.sql.Connection getConnection(java.lang.String url,
                                                   java.lang.String user,
                                                   java.lang.String pass)
                                            throws java.sql.SQLException

Purpose: getConnection;
does this first: if (loadedDriver == null) loadDriver(null);
then opens the connection

Parameters:

url, - String

user, - String

pass, - String

Returns:

Connection

Throws:

java.sql.SQLException

loadDriver

protected static java.lang.Class loadDriver(java.lang.String driver)
                                     throws java.sql.SQLException

Purpose: load driver

Parameters:

driver, - String, if null will load the DEFAULT_DRIVER

Throws:

java.sql.SQLException

setJdbcDriver

public static void setJdbcDriver(Processor pr)
                          throws SAFSException

Purpose: setJdbcDriver

Parameters:

pr, - Processor

Throws:

SAFSException

copyDBTableColumnToFile

public static void copyDBTableColumnToFile(Processor pr)
                                    throws SAFSException

Purpose: copyDBTableColumnToFile

This routine will export the contents of a DBTable to a delimeted file.

A data source name and Query String is required.

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBSourceName
Name of the Datasource containing the DBTable
3. FileOut
Name of the output file.
4. SQLQuery
The file will contain the results of the executed Query. The query is NOT validated by this function.
5. [ DirectoryOut ]
If not specified the file will be stored in the default test directory.
6. [ SQLStatus ]
A variable which holds the current SQL run status.
7. [ delimiter ]
If not specified the default ',' seperator will be used.
8. [ UserID ]
UserID for accessing the Datasource (if required).
9. [ Password ]
Password for accessing the Datasource (if required).
Examples:
C, CopyDBTableColumnToFile, ADBAlias, ATableAlias, Data Source Name (dsn), OutputFileName, [SQLQuery], [OutputDirectory], [Delimiter], [sqlStatus], "[UID]", "[PWD]"

Parameters:

pr, - Processor

Throws:

SAFSException

copyDBTableToFile

public static void copyDBTableToFile(Processor pr)
                              throws SAFSException

Purpose: copyDBTableToFile

This routine will export the contents of a DBTable to a delimeted file.

A data source name, file out name, and table name are required.

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBSourceName
Name of the Datasource containing the DBTable
3. FileOut
Name of the output file.
4. DBTableName
Name of the TABLE to access within the DBSourceName
5. [ ColumnCount ]
If specified the output file will contain only the number of columns specified.
6. [ RowCount ]
If specified the output file will contain only the number of columns specified.
7. [ SQLQuery ]
If specified, the file will contain the results of the executed Query. The query is NOT validated by this function.
8. [ delimiter ]
If not specified the default ',' seperator will be used.
9. [ DirectoryOut ]
If not specified the file will be stored in the default test directory.
10. [ SQLStatus ]
A variable which holds the current SQL run status.
11. [ UserID ]
UserID for accessing the Datasource (if required).
12. [ Password ]
Password for accessing the Datasource (if required).
Examples:
C, CopyDBTableToFile, ADBAlias, ATableAlias, Data Source Name (dsn), OutputFileName, tableName, [ColumnCount],[rowCount], [SQLQuery], [Delimiter], [OutputDirectory], [sqlStatus], "[UID]", "[PWD]"

Parameters:

pr, - Processor

Throws:

SAFSException

deleteDBTableRecords

public static void deleteDBTableRecords(Processor pr)
                                 throws SAFSException

Purpose: deleteDBTableRecords
Deletes records in a database table

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBTableName
Name of the TABLE to access within the DBSourceName
3. DBQueryCond
Expression allowed by the WHERE clause of the delete sentence of the SQL driver
A query condition can be included. It can be any valid expression allowed by the WHERE clause of the delete sentence of the SQL driver you are using. For example: "CliBal > 100000 and CliCat = 'C'". "where" will be added to any expression if it is not provided ("")
4. DBSourceName
Name of the Datasource containing the DBTable
5. [ UserID]
UserID for accessing the Datasource (if required).
6. [ Password]
Password for accessing the Datasource (if required).
7. [ SQLStatus ]
SQL status code as a result of executing the query gets stored in this variable

Parameters:

pr, - Processor

Throws:

SAFSException

execSQLQuery

public static void execSQLQuery(Processor pr)
                         throws SAFSException

Purpose: execSQLQuery
Executes the query provided in a queryStr on the database table.

Parameters:

pr, - Processor

Throws:

SAFSException

execSQLCommit

public static void execSQLCommit(Processor pr)
                          throws SAFSException

Purpose: execSqlCommit
Commits the pending queries on the database.

Parameters:

pr, - Processor

Throws:

SAFSException

getDBTableColumnCount

public static void getDBTableColumnCount(Processor pr)
                                  throws SAFSException

Purpose: getDBTableColumnCount
Executes 'select * from table' and returns the total column count.

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBSourceName
Name of the Datasource containing the DBTable
3. DBTableName
Name of the TABLE to access within the DBSourceName
4. ColumnCount
total column count gets stored in this variable
5. SQLStatus
SQL status code as a result of executing the query gets stored in this variable
6. [ UserID ]
UserID for accessing the Datasource (if required).
7. [ Password ]
Password for accessing the Datasource (if required).
Examples:
C, getDBTableRowCount, ADBAlias, ATableAlias, Data Source Name (dsn), tableName, RowCount, sqlStatus, "[UID]", "[PWD]"

Parameters:

pr, - Processor

Throws:

SAFSException

getDBTableRowCount

public static void getDBTableRowCount(Processor pr)
                               throws SAFSException

Purpose: getDBTableRowCount
Executes 'select * from table' and returns the total row count.

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBSourceName
Name of the Datasource containing the DBTable
3. DBTableName
Name of the TABLE to access within the DBSourceName
4. RowCount
total row count gets stored in this variable
5. SQLStatus
SQL status code as a result of executing the query gets stored in this variable
6. [ UserID ]
UserID for accessing the Datasource (if required).
7. [ Password ]
Password for accessing the Datasource (if required).
Examples:
C, getDBTableRowCount, ADBAlias, ATableAlias, Data Source Name (dsn), tableName, RowCount, sqlStatus, "[UID]", "[PWD]"

Parameters:

pr, - Processor

Throws:

SAFSException

getDBValue

public static void getDBValue(Processor pr)
                       throws SAFSException

Purpose: getDBValue getAlternateParams:

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBSourceName - Name of the Datasource containing the DBTable
3. queryStr - Actual query stored in a queryStr.
4. queryResult - variable to place query result
5. SQLStatusCode - SQL status code as a result of executing the query.
6. [ UserID = ] - UserID for accessing the Datasource (if required).
7. [ Password = ] - Password for accessing the Datasource (if required).

Parameters:

pr, - Processor

Throws:

SAFSException

verifyDatabaseNullValue

public static void verifyDatabaseNullValue(Processor pr)
                                    throws SAFSException

Purpose: verifyDatabaseNullValue
Verifies that the value of a field in a database table is NULL.

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBFieldName
Name of the FIELD within DBTableName used in the verification
3. DBTableName
Name of the TABLE to access within the DBSourceName
4. DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included. It can be any valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver you are using. For example: "CliBal > 100000 and CliCat = 'C'". "where" will be added to any expression if it is not provided ("")
5. DBSourceName
Name of the Datasource containing the DBTable
6. [ UserID]
UserID for accessing the Datasource (if required).
7. [ Password]
Password for accessing the Datasource (if required).
8. [ SQLStatus ]
SQL status code as a result of executing the query gets stored in this variable

Parameters:

pr, - Processor

Throws:

SAFSException

verifyDatabaseValue

public static void verifyDatabaseValue(Processor pr)
                                throws SAFSException

Purpose: verifyDatabaseValue:
Verifies the case-sensitive value of a field in a database table.

0. ADBAlias - ignored
1. ATableAlias - ignored
2. DBFieldName
Name of the FIELD within DBTableName used in the verification
3. DBTableName
Name of the TABLE to access within the DBSourceName
4. DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included. It can be any valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver you are using. For example: "CliBal > 100000 and CliCat = 'C'". "where" will be added to any expression if it is not provided ("")
5. DBSourceName
Name of the Datasource containing the DBTable
6. UserID
UserID for accessing the Datasource (if required).
7. Password
Password for accessing the Datasource (if required).
8. ExpectedValue
Benchmark value to compare against retrieved DBFieldName value
9. [ SQLStatus ]
SQL status code as a result of executing the query gets stored in this variable

Parameters:

pr, - Processor

Throws:

SAFSException

verifyDBNullValue

public static void verifyDBNullValue(Processor pr)
                              throws SAFSException

Purpose: verifyDBNullValue: same as verifyDatabaseNullValue

Parameters:

pr, - Processor

Throws:

SAFSException

verifyDBValue

public static void verifyDBValue(Processor pr)
                          throws SAFSException

Purpose: verifyDBValue: same as verifyDatabaseValue

Parameters:

pr, - Processor

Throws:

SAFSException