com.konakart.db

Class KKBasePeer

java.lang.Object

com.konakart.db.KKBasePeer

All Implemented Interfaces:

java.io.Serializable

public abstract class KKBasePeer
extends java.lang.Object
implements java.io.Serializable

This is the base class for all Peer classes in the system. Peer classes are responsible for isolating all of the database access for a specific business object. They execute all of the SQL against the database. Over time this class has grown to include utility methods which ease execution of cross-database queries and the implementation of concrete Peers.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IGNORE_CASE Constant criteria key to remove Case Information from search/ordering criteria.
protected static org.apache.commons.logging.Log	log the log
static java.lang.String	ORDER_BY Constant criteria key to reference ORDER BY columns.
static java.lang.String	TABLE_NAME Classes that implement this class should override this value.

Constructor Summary

Constructors

Constructor and Description
KKBasePeer()

Method Summary

Modifier and Type	Method and Description
static void	correctBooleans(org.apache.torque.util.Criteria criteria, org.apache.torque.map.TableMap defaultTableMap) Checks all columns in the criteria to see whether booleanchar and booleanint columns are queried with a boolean.
static void	createInsertQuery(KKCriteria criteria) Create an INSERT query from the criteria.
static org.apache.torque.sql.Query	createQuery(KKCriteria criteria) Method to create an SQL query based on values in a Criteria.
static java.lang.String	createQueryDisplayString(java.lang.String queryString, java.util.List<java.lang.Object> replacements) Create a String representation of the Prepared Statement
static java.lang.String	createQueryString(KKCriteria criteria) Method to create an SQL query for actual execution based on values in a Criteria.
static java.lang.String	createUpdateQuery(KKCriteria selectC, KKCriteria updateC) Create an UPDATE query from the two criteria objects.
static void	deleteAll(java.sql.Connection con, java.lang.String table, java.lang.String column, int value) Convenience method that uses straight JDBC to delete multiple rows.
static void	deleteAll(java.lang.String table, java.lang.String column, int value) Convenience method that uses straight JDBC to delete multiple rows.
static int	doDelete(KKCriteria criteria, java.lang.String tableName) Method to perform deletes based on values and keys in a Criteria.
static int	doDelete(KKCriteria criteria, java.lang.String tableName, java.sql.Connection con) Method to perform deletes based on values and keys in a Criteria.
static org.apache.torque.om.ObjectKey	doInsert(KKCriteria criteria) Method to perform inserts based on values and keys in a Criteria.
static org.apache.torque.om.ObjectKey	doInsert(KKCriteria criteria, java.sql.Connection con) Method to perform inserts based on values and keys in a Criteria.
static java.util.List<com.workingdogs.village.Record>	doSelect(KKCriteria criteria) Returns all results.
static java.util.List<com.workingdogs.village.Record>	doSelect(KKCriteria criteria, java.sql.Connection connection) Performs a SQL select using a PreparedStatement.
static java.util.List<com.workingdogs.village.Record>	doSelect(KKCriteria criteria, int retryMax) Returns all results.
static int	doUpdate(KKCriteria updateValues) Convenience method used to update rows in the DB.
static int	doUpdate(KKCriteria updateValues, java.sql.Connection con) Convenience method used to update rows in the DB.
static int	doUpdate(KKCriteria selectC, KKCriteria updateC) Method used to update rows in the DB.
static int	doUpdate(KKCriteria criteria, KKCriteria updateValues, java.sql.Connection con) Method used to update rows in the DB.
static int	doUpdate(KKCriteria selectC, KKCriteria updateC, int retryMax) Method used to update rows in the DB.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString) Utility method which executes a given sql statement.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, boolean singleRecord, java.sql.Connection con) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, int start, int numberOfResults, boolean singleRecord, java.sql.Connection con) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, int start, int numberOfResults, java.lang.String dbName, boolean singleRecord) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.util.List<java.lang.Object> whereValues) Utility method which executes a given sql statement.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.util.List<java.lang.Object> whereValues, boolean singleRecord, java.sql.Connection con) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.util.List<java.lang.Object> whereValues, int start, int numberOfResults, boolean singleRecord, java.sql.Connection con) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.util.List<java.lang.Object> whereValues, int start, int numberOfResults, java.lang.String dbName, boolean singleRecord) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.util.List<java.lang.Object> whereValues, java.lang.String dbName) Utility method which executes a given sql statement.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.util.List<java.lang.Object> whereValues, java.lang.String dbName, boolean singleRecord) Method for performing a SELECT.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.lang.String dbName) Utility method which executes a given sql statement.
static java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, java.lang.String dbName, boolean singleRecord) Method for performing a SELECT.
static int	executeStatement(java.lang.String statementString) Utility method which executes a given sql statement.
static int	executeStatement(java.lang.String statementString, java.sql.Connection con) Utility method which executes a given sql statement.
static int	executeStatement(java.lang.String statementString, java.lang.String dbName) Utility method which executes a given sql statement.
static java.util.List<com.workingdogs.village.Record>	getSelectResults(com.workingdogs.village.QueryDataSet qds) Returns all records in a QueryDataSet as a List of Record objects.
static java.util.List<com.workingdogs.village.Record>	getSelectResults(com.workingdogs.village.QueryDataSet qds, boolean singleRecord) Returns all records in a QueryDataSet as a List of Record objects.
static java.util.List<com.workingdogs.village.Record>	getSelectResults(com.workingdogs.village.QueryDataSet qds, int numberOfResults, boolean singleRecord) Returns numberOfResults records in a QueryDataSet as a List of Record objects.
static java.util.List<com.workingdogs.village.Record>	getSelectResults(com.workingdogs.village.QueryDataSet qds, int start, int numberOfResults, boolean singleRecord) Returns numberOfResults records in a QueryDataSet as a List of Record objects.
static org.apache.torque.map.TableMap	getTableMap(KKCriteria criteria)
static org.apache.torque.map.TableMap	getTableMap(KKCriteria criteria, java.lang.String defTableName)
protected static void	handleMultipleRecords(com.workingdogs.village.DataSet ds) If the user specified that (s)he only wants to retrieve a single record and multiple records are retrieved, this method is called to handle the situation.
static java.lang.String[]	initColumnNames(com.workingdogs.village.Column[] columns) Convenience method to create a String array of column names.
static java.lang.String[]	initCriteriaKeys(java.lang.String tableName, java.lang.String[] columnNames) Convenience method to create a String array of criteria keys.
static com.workingdogs.village.Column[]	initTableColumns(com.workingdogs.village.Schema schema) Creates a Column array for a table based on its Schema.
static com.workingdogs.village.Schema	initTableSchema(java.lang.String tableName) Sets up a Schema for a table.
static com.workingdogs.village.Schema	initTableSchema(java.lang.String tableName, java.lang.String dbName) Sets up a Schema for a table.
static boolean	isDataTooLongException(java.lang.String eMsg) Test to see whether the exception message contains some key strings that indicate that a "data too long" problem has occurred.
static boolean	isDB2() Are we using DB2?
static boolean	isDeadlockException(java.sql.SQLException se) Does this exception indicate a deadlock?
static boolean	isMSSqlServer() Are we using SQL Server?
static boolean	isMySql() Are we using MySQL?
static boolean	isOracle() Are we using Oracle?
static boolean	isPostgreSQL() Are we using PostgreSQL?
static java.lang.String	jdbcValueToString(org.apache.torque.util.JdbcTypedValue jdbcVal) Get a String representation of the JDBC value
static java.util.List<com.workingdogs.village.Record>	select(KKCriteria selectC) Return a list of Record objects by executing the query defined by the criteria object

Methods inherited from class java.lang.Object

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

Field Detail

ORDER_BY

public static final java.lang.String ORDER_BY

Constant criteria key to reference ORDER BY columns.

See Also:

Constant Field Values

IGNORE_CASE

public static final java.lang.String IGNORE_CASE

Constant criteria key to remove Case Information from search/ordering criteria.

See Also:

Constant Field Values

TABLE_NAME

public static final java.lang.String TABLE_NAME

Classes that implement this class should override this value.

See Also:

Constant Field Values

log

protected static final org.apache.commons.logging.Log log

the log

Constructor Detail

KKBasePeer

public KKBasePeer()

Method Detail

initTableSchema

public static com.workingdogs.village.Schema initTableSchema(java.lang.String tableName)

Sets up a Schema for a table. This schema is then normally used as the argument for initTableColumns().

Parameters:

tableName - The name of the table.

Returns:

A Schema.

initTableSchema

public static com.workingdogs.village.Schema initTableSchema(java.lang.String tableName,
                                                             java.lang.String dbName)

Sets up a Schema for a table. This schema is then normally used as the argument for initTableColumns

Parameters:

tableName - The property name for the database in the configuration file.

dbName - The name of the database.

Returns:

A Schema.

initTableColumns

public static com.workingdogs.village.Column[] initTableColumns(com.workingdogs.village.Schema schema)

Creates a Column array for a table based on its Schema.

Parameters:

schema - A Schema object.

Returns:

A Column[].

initColumnNames

public static java.lang.String[] initColumnNames(com.workingdogs.village.Column[] columns)

Convenience method to create a String array of column names.

Parameters:

columns - A Column[].

Returns:

A String[].

initCriteriaKeys

public static java.lang.String[] initCriteriaKeys(java.lang.String tableName,
                                                  java.lang.String[] columnNames)

Convenience method to create a String array of criteria keys.

Parameters:

tableName - Name of table.

columnNames - A String[].

Returns:

A String[].

deleteAll

public static void deleteAll(java.sql.Connection con,
                             java.lang.String table,
                             java.lang.String column,
                             int value)
                      throws org.apache.torque.TorqueException

Convenience method that uses straight JDBC to delete multiple rows. Village throws an Exception when multiple rows are deleted.

Parameters:

con - A Connection.

table - The table to delete records from.

column - The column in the where clause.

value - The value of the column.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

deleteAll

public static void deleteAll(java.lang.String table,
                             java.lang.String column,
                             int value)
                      throws org.apache.torque.TorqueException

Convenience method that uses straight JDBC to delete multiple rows. Village throws an Exception when multiple rows are deleted. This method attempts to get the default database from the pool.

Parameters:

table - The table to delete records from.

column - The column in the where clause.

value - The value of the column.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static int doDelete(KKCriteria criteria,
                           java.lang.String tableName)
                    throws org.apache.torque.TorqueException

Method to perform deletes based on values and keys in a Criteria. KonaKart Torque - was made public This method is protected because it may cause ambiguity between doDelete(Criteria,Connection) and this method. It will be made public once doDelete(Criteria, Connection) is removed.

Parameters:

criteria - The criteria to use.

tableName - the name of the table to delete records from. If set to null, the name of the table(s) can be extracted from the criteria, but this can cause unexpected results.

Returns:

Returns the number of deleted rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doDelete

public static int doDelete(KKCriteria criteria,
                           java.lang.String tableName,
                           java.sql.Connection con)
                    throws org.apache.torque.TorqueException

Method to perform deletes based on values and keys in a Criteria.

Parameters:

criteria - The criteria to use.

tableName - the tableName to delete records from. If set to null, the name of the table(s) can be extracted from the criteria, but this can cause unexpected results.

con - A Connection.

Returns:

Returns the number of deleted rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doInsert

public static org.apache.torque.om.ObjectKey doInsert(KKCriteria criteria)
                                               throws org.apache.torque.TorqueException

Method to perform inserts based on values and keys in a Criteria.

If the primary key is auto incremented the data in Criteria will be inserted and the auto increment value will be returned.

If the primary key is included in Criteria then that value will be used to insert the row.

If no primary key is included in Criteria then we will try to figure out the primary key from the database map and insert the row with the next available id using util.db.IDBroker.

If no primary key is defined for the table the values will be inserted as specified in Criteria and -1 will be returned.

Parameters:

criteria - Object containing values to insert.

Returns:

An Object which is the id of the row that was inserted (if the table has a primary key) or null (if the table does not have a primary key).

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doInsert

public static org.apache.torque.om.ObjectKey doInsert(KKCriteria criteria,
                                                      java.sql.Connection con)
                                               throws org.apache.torque.TorqueException

Method to perform inserts based on values and keys in a Criteria.

If the primary key is auto incremented the data in Criteria will be inserted and the auto increment value will be returned.

If the primary key is included in Criteria then that value will be used to insert the row.

If no primary key is included in Criteria then we will try to figure out the primary key from the database map and insert the row with the next available id using util.db.IDBroker.

If no primary key is defined for the table the values will be inserted as specified in Criteria and null will be returned.

Parameters:

criteria - Object containing values to insert.

con - A Connection.

Returns:

An Object which is the id of the row that was inserted (if the table has a primary key) or null (if the table does not have a primary key).

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

createInsertQuery

public static void createInsertQuery(KKCriteria criteria)

Create an INSERT query from the criteria. The result is set on the criteria's DisplayQuery attribute.

Parameters:

criteria - the criteria

jdbcValueToString

public static java.lang.String jdbcValueToString(org.apache.torque.util.JdbcTypedValue jdbcVal)

Get a String representation of the JDBC value

Parameters:

jdbcVal - the jdbcVal

Returns:

a String representation of the JDBC value

getTableMap

public static org.apache.torque.map.TableMap getTableMap(KKCriteria criteria,
                                                         java.lang.String defTableName)
                                                  throws org.apache.torque.TorqueException

Parameters:

criteria - the criteria

defTableName - Use this default table name if another one can't be derived

Returns:

the TableMap for the Criteria

Throws:

org.apache.torque.TorqueException - an unexpected TorqueException exception

getTableMap

public static org.apache.torque.map.TableMap getTableMap(KKCriteria criteria)
                                                  throws org.apache.torque.TorqueException

Parameters:

criteria - the criteria

Returns:

the TableMap for the Criteria

Throws:

org.apache.torque.TorqueException - an unexpected TorqueException exception

createQueryDisplayString

public static java.lang.String createQueryDisplayString(java.lang.String queryString,
                                                        java.util.List<java.lang.Object> replacements)

Create a String representation of the Prepared Statement

Parameters:

queryString - the queryString

replacements - the replacements

Returns:

a String representing the SQL creating by setting the parameters in the queryString

createQueryString

public static java.lang.String createQueryString(KKCriteria criteria)
                                          throws org.apache.torque.TorqueException

Method to create an SQL query for actual execution based on values in a Criteria.

Parameters:

criteria - A Criteria.

Returns:

the SQL query for actual execution

Throws:

org.apache.torque.TorqueException - Trouble creating the query string.

createQuery

public static org.apache.torque.sql.Query createQuery(KKCriteria criteria)
                                               throws org.apache.torque.TorqueException

Method to create an SQL query based on values in a Criteria. Note that final manipulation of the limit and offset are performed when the query is actually executed.

Parameters:

criteria - A Criteria.

Returns:

the sql query

Throws:

org.apache.torque.TorqueException - Trouble creating the query string.

doSelect

public static java.util.List<com.workingdogs.village.Record> doSelect(KKCriteria criteria)
                                                               throws org.apache.torque.TorqueException

Returns all results.

Parameters:

criteria - A Criteria.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doSelect

public static java.util.List<com.workingdogs.village.Record> doSelect(KKCriteria criteria,
                                                                      int retryMax)
                                                               throws org.apache.torque.TorqueException

Returns all results.

Parameters:

criteria - A Criteria.

retryMax - Maximum retries that will be attempted if we get deadlock exceptions - only applicable on MS SQL Server and DB2

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doSelect

public static java.util.List<com.workingdogs.village.Record> doSelect(KKCriteria criteria,
                                                                      java.sql.Connection connection)
                                                               throws org.apache.torque.TorqueException

Performs a SQL select using a PreparedStatement.

Parameters:

criteria - A Criteria specifying the records to select, not null.

connection - the database connection for selecting records, not null.

Returns:

The results of the query, not null.

Throws:

org.apache.torque.TorqueException - Error performing database query.

isDeadlockException

public static boolean isDeadlockException(java.sql.SQLException se)

Does this exception indicate a deadlock?

Parameters:

se - SQLException

Returns:

Returns true if it is a deadlock exception

isDataTooLongException

public static boolean isDataTooLongException(java.lang.String eMsg)

Test to see whether the exception message contains some key strings that indicate that a "data too long" problem has occurred. The strings searched for are different for different databases.

Parameters:

eMsg - The Exception message

Returns:

Returns true if it is a data too long exception

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString)
                                                                   throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for select statements only. Use executeStatement for update, insert, and delete operations.

Parameters:

queryString - A String with the sql statement to execute.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.lang.String dbName)
                                                                   throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for select statements only. Use executeStatement for update, insert, and delete operations.

Parameters:

queryString - A String with the sql statement to execute.

dbName - The database to connect to.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.util.List<java.lang.Object> whereValues)
                                                                   throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for select statements only. Use executeStatement for update, insert, and delete operations.

Parameters:

queryString - A String with the sql statement to execute.

whereValues - values for replacement in the prepared statement

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.util.List<java.lang.Object> whereValues,
                                                                          java.lang.String dbName)
                                                                   throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for select statements only. Use executeStatement for update, insert, and delete operations.

Parameters:

queryString - A String with the sql statement to execute.

whereValues - values for replacement in the prepared statement

dbName - The database to connect to.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.lang.String dbName,
                                                                          boolean singleRecord)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT. Returns all results.

Parameters:

queryString - A String with the sql statement to execute.

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.util.List<java.lang.Object> whereValues,
                                                                          java.lang.String dbName,
                                                                          boolean singleRecord)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT. Returns all results.

Parameters:

queryString - A String with the sql statement to execute.

whereValues - values for replacement in the prepared statement

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          boolean singleRecord,
                                                                          java.sql.Connection con)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT. Returns all results.

Parameters:

queryString - A String with the sql statement to execute.

singleRecord - Whether or not we want to select only a single record.

con - A Connection.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.util.List<java.lang.Object> whereValues,
                                                                          boolean singleRecord,
                                                                          java.sql.Connection con)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT. Returns all results.

Parameters:

queryString - A String with the sql statement to execute.

whereValues - values for replacement in the prepared statement

singleRecord - Whether or not we want to select only a single record.

con - A Connection.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          int start,
                                                                          int numberOfResults,
                                                                          java.lang.String dbName,
                                                                          boolean singleRecord)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT.

Parameters:

queryString - A String with the sql statement to execute.

start - The first row to return.

numberOfResults - The number of rows to return.

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.util.List<java.lang.Object> whereValues,
                                                                          int start,
                                                                          int numberOfResults,
                                                                          java.lang.String dbName,
                                                                          boolean singleRecord)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT.

Parameters:

queryString - A String with the sql statement to execute.

whereValues - the where clause values used in prepared statements

start - The first row to return.

numberOfResults - The number of rows to return.

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          int start,
                                                                          int numberOfResults,
                                                                          boolean singleRecord,
                                                                          java.sql.Connection con)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT. Returns all results.

Parameters:

queryString - A String with the sql statement to execute.

start - The first row to return.

numberOfResults - The number of rows to return.

singleRecord - Whether or not we want to select only a single record.

con - A Connection.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

public static java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                          java.util.List<java.lang.Object> whereValues,
                                                                          int start,
                                                                          int numberOfResults,
                                                                          boolean singleRecord,
                                                                          java.sql.Connection con)
                                                                   throws org.apache.torque.TorqueException

Method for performing a SELECT. Returns all results.

Parameters:

queryString - A String with the sql statement to execute.

start - The first row to return.

numberOfResults - The number of rows to return.

singleRecord - Whether or not we want to select only a single record.

whereValues - the where clause values used in prepared statements

con - A Connection.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

getSelectResults

public static java.util.List<com.workingdogs.village.Record> getSelectResults(com.workingdogs.village.QueryDataSet qds)
                                                                       throws org.apache.torque.TorqueException

Returns all records in a QueryDataSet as a List of Record objects. Used for functionality like util.LargeSelect.

Parameters:

qds - the QueryDataSet

Returns:

a List of Record objects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

See Also:

getSelectResults(QueryDataSet, int, int, boolean)

getSelectResults

public static java.util.List<com.workingdogs.village.Record> getSelectResults(com.workingdogs.village.QueryDataSet qds,
                                                                              boolean singleRecord)
                                                                       throws org.apache.torque.TorqueException

Returns all records in a QueryDataSet as a List of Record objects. Used for functionality like util.LargeSelect.

Parameters:

qds - the QueryDataSet

singleRecord - the singleRecord

Returns:

a List of Record objects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

See Also:

getSelectResults(QueryDataSet, int, int, boolean)

getSelectResults

public static java.util.List<com.workingdogs.village.Record> getSelectResults(com.workingdogs.village.QueryDataSet qds,
                                                                              int numberOfResults,
                                                                              boolean singleRecord)
                                                                       throws org.apache.torque.TorqueException

Returns numberOfResults records in a QueryDataSet as a List of Record objects. Starting at record 0. Used for functionality like util.LargeSelect.

Parameters:

qds - the QueryDataSet

numberOfResults - the numberOfResults

singleRecord - the singleRecord

Returns:

a List of Record objects

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

See Also:

getSelectResults(QueryDataSet, int, int, boolean)

getSelectResults

public static java.util.List<com.workingdogs.village.Record> getSelectResults(com.workingdogs.village.QueryDataSet qds,
                                                                              int start,
                                                                              int numberOfResults,
                                                                              boolean singleRecord)
                                                                       throws org.apache.torque.TorqueException

Returns numberOfResults records in a QueryDataSet as a List of Record objects. Starting at record start. Used for functionality like util.LargeSelect.

Parameters:

qds - The QueryDataSet to extract results from.

start - The index from which to start retrieving Record objects from the data set.

numberOfResults - The number of results to return (or -1 for all results).

singleRecord - Whether or not we want to select only a single record.

Returns:

A List of Record objects.

Throws:

org.apache.torque.TorqueException - If any Exception occurs.

doUpdate

public static int doUpdate(KKCriteria updateValues)
                    throws org.apache.torque.TorqueException

Convenience method used to update rows in the DB. Checks if a single int primary key is specified in the Criteria object and uses it to perform the udpate. If no primary key is specified an Exception will be thrown.

Use this method for performing an update of the kind:

"WHERE primary_key_id = an int"

To perform an update with non-primary key fields in the WHERE clause use doUpdate(criteria, criteria).

Parameters:

updateValues - A Criteria object containing values used in set clause.

Returns:

the number of affected rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static int doUpdate(KKCriteria updateValues,
                           java.sql.Connection con)
                    throws org.apache.torque.TorqueException

Convenience method used to update rows in the DB. Checks if a single int primary key is specified in the Criteria object and uses it to perform the update. If no primary key is specified an Exception will be thrown.

Use this method for performing an update of the kind:

"WHERE primary_key_id = an int"

To perform an update with non-primary key fields in the WHERE clause use doUpdate(criteria, criteria).

Parameters:

updateValues - A Criteria object containing values used in set clause.

con - A Connection.

Returns:

the number of affected rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static int doUpdate(KKCriteria selectC,
                           KKCriteria updateC)
                    throws org.apache.torque.TorqueException

Method used to update rows in the DB. Rows are selected based on selectCriteria and updated using values in updateC.

Use this method for performing an update of the kind:

WHERE some_column = some value AND could_have_another_column = another value AND so on...

Parameters:

selectC - A Criteria object containing values used in where clause.

updateC - A Criteria object containing values used in set clause.

Returns:

the number of affected rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doUpdate

public static int doUpdate(KKCriteria selectC,
                           KKCriteria updateC,
                           int retryMax)
                    throws org.apache.torque.TorqueException

Method used to update rows in the DB. Rows are selected based on selectCriteria and updated using values in updateC.

Use this method for performing an update of the kind:

WHERE some_column = some value AND could_have_another_column = another value AND so on...

Parameters:

selectC - A Criteria object containing values used in where clause.

updateC - A Criteria object containing values used in set clause.

retryMax - Maximum retries that will be attempted if we get deadlock exceptions - only applicable on MS SQL Server and DB2

Returns:

the number of affected rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

doUpdate

public static int doUpdate(KKCriteria criteria,
                           KKCriteria updateValues,
                           java.sql.Connection con)
                    throws org.apache.torque.TorqueException

Method used to update rows in the DB. Rows are selected based on criteria and updated using values in updateValues.

Use this method for performing an update of the kind:

WHERE some_column = some value AND could_have_another_column = another value AND so on.

Parameters:

criteria - A Criteria object containing values used in where clause.

updateValues - A Criteria object containing values used in set clause.

con - A Connection.

Returns:

the number of affected rows.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

createUpdateQuery

public static java.lang.String createUpdateQuery(KKCriteria selectC,
                                                 KKCriteria updateC)
                                          throws org.apache.torque.TorqueException

Create an UPDATE query from the two criteria objects. The result is set on the update criteria's DisplayQuery attribute.

Parameters:

selectC - the selectC

updateC - the updateC

Returns:

an UPDATE query for display

Throws:

org.apache.torque.TorqueException - an unexpected TorqueException exception

executeStatement

public static int executeStatement(java.lang.String statementString)
                            throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for update, insert, and delete statements. Use executeQuery() for selects.

Parameters:

statementString - A String with the sql statement to execute.

Returns:

The number of rows affected.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeStatement

public static int executeStatement(java.lang.String statementString,
                                   java.lang.String dbName)
                            throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for update, insert, and delete statements. Use executeQuery() for selects.

Parameters:

statementString - A String with the sql statement to execute.

dbName - Name of database to connect to.

Returns:

The number of rows affected.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

executeStatement

public static int executeStatement(java.lang.String statementString,
                                   java.sql.Connection con)
                            throws org.apache.torque.TorqueException

Utility method which executes a given sql statement. This method should be used for update, insert, and delete statements. Use executeQuery() for selects.

Parameters:

statementString - A String with the sql statement to execute.

con - A Connection.

Returns:

The number of rows affected.

Throws:

org.apache.torque.TorqueException - Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

handleMultipleRecords

protected static void handleMultipleRecords(com.workingdogs.village.DataSet ds)
                                     throws org.apache.torque.TorqueException

If the user specified that (s)he only wants to retrieve a single record and multiple records are retrieved, this method is called to handle the situation. The default behavior is to throw an exception, but subclasses can override this method as needed.

Parameters:

ds - The DataSet which contains multiple records.

Throws:

org.apache.torque.TorqueException - Couldn't handle multiple records.

correctBooleans

public static void correctBooleans(org.apache.torque.util.Criteria criteria,
                                   org.apache.torque.map.TableMap defaultTableMap)
                            throws org.apache.torque.TorqueException

Checks all columns in the criteria to see whether booleanchar and booleanint columns are queried with a boolean. If yes, the query values are mapped onto values the database does understand, i.e. 0 and 1 for booleanints and N and Y for booleanchar columns.

Parameters:

criteria - The criteria to be checked for booleanint and booleanchar columns.

defaultTableMap - the table map to be used if the table name is not given in a column.

Throws:

org.apache.torque.TorqueException - if the database map for the criteria cannot be retrieved.

isDB2

public static boolean isDB2()

Are we using DB2?

Returns:

true if DB2

isPostgreSQL

public static boolean isPostgreSQL()

Are we using PostgreSQL?

Returns:

true if PostgreSQL

isOracle

public static boolean isOracle()

Are we using Oracle?

Returns:

true if Oracle

isMySql

public static boolean isMySql()

Are we using MySQL?

Returns:

true if MySQL

isMSSqlServer

public static boolean isMSSqlServer()

Are we using SQL Server?

Returns:

true if SQL Server

select

public static java.util.List<com.workingdogs.village.Record> select(KKCriteria selectC)
                                                             throws org.apache.torque.TorqueException

Return a list of Record objects by executing the query defined by the criteria object

Parameters:

selectC - select criteria object

Returns:

a list of Record objects

Throws:

org.apache.torque.TorqueException - an unexpected TorqueException exception