com.konakart.db

Class KKTorque

java.lang.Object

com.konakart.db.KKTorque

public class KKTorque
extends java.lang.Object

Various utilities for using Torque in KonaKart

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log

Method Summary

Modifier and Type	Method and Description
static void	addAdapters() Add Database Adapters to Torque
static java.sql.Connection	beginTransaction(java.lang.String dbName) Get a Connection to the database for starting a transaction - defaulting to auto commit being OFF
static java.sql.Connection	beginTransaction(java.lang.String dbName, boolean autoCommit) Get a Connection to the database for starting a transaction
static java.lang.String	fixQueryString(java.lang.String queryString) Some post processing of the query string to fix the query so that it will run.
static org.apache.torque.adapter.Adapter	getAdapter(java.lang.String name) Returns the database adapter for a specific database name.
static org.apache.torque.map.DatabaseMap	getDatabaseMap(java.lang.String name) Returns the database map information for a given database.
static org.apache.torque.adapter.Adapter	getDB(java.lang.String name) Deprecated. use getAdapter(String) instead. This method will be removed in a future version of Torque.
static java.lang.String	getDbOwner()
static KKDbMapMgr	getKkDbMapMgr()
static char	getStringDelimiter() Returns the character used to indicate the beginning and end of a piece of text used in a SQL statement (generally a single quote).
static java.lang.String	getTableDotColumn(org.apache.torque.map.ColumnMap colMap) Get tableName + "." + columnName from the ColumnMap
static void	init() Initialise/Amend the KonaKart Torque data structures for "problem" databases (like Oracle)
static boolean	isColumnAnOracleCLOB(java.lang.String table, java.lang.String column, java.lang.String key) Is the custom_attrs column is an Oracle CLOB? Return true if it is otherwise false.
static void	setDbOwner(java.lang.String dbOwner)

Methods inherited from class java.lang.Object

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

Field Detail

log

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

the log

Method Detail

init

public static void init()
                 throws com.konakart.app.KKException

Initialise/Amend the KonaKart Torque data structures for "problem" databases (like Oracle)

Throws:

com.konakart.app.KKException - an unexpected KKException exception

fixQueryString

public static java.lang.String fixQueryString(java.lang.String queryString)

Some post processing of the query string to fix the query so that it will run. We only need to do this if we have price constraints.

Parameters:

queryString - the queryString

Returns:

Modified query string

getKkDbMapMgr

public static KKDbMapMgr getKkDbMapMgr()

Returns:

Returns the kkDbMapMgr.

getDbOwner

public static java.lang.String getDbOwner()

Returns:

Returns the dbOwner.

setDbOwner

public static void setDbOwner(java.lang.String dbOwner)

Parameters:

dbOwner - The dbOwner to set.

getDatabaseMap

public static org.apache.torque.map.DatabaseMap getDatabaseMap(java.lang.String name)
                                                        throws org.apache.torque.TorqueException

Returns the database map information for a given database.

Parameters:

name - The name of the database corresponding to the DatabaseMap to retrieve, or null for the default database.

Returns:

The named DatabaseMap, not null.

Throws:

org.apache.torque.TorqueException - if Torque is not initialized and name is null.

getStringDelimiter

public static char getStringDelimiter()

Returns the character used to indicate the beginning and end of a piece of text used in a SQL statement (generally a single quote).

Returns:

The text delimeter.

beginTransaction

public static java.sql.Connection beginTransaction(java.lang.String dbName)
                                            throws org.apache.torque.TorqueException,
                                                   java.sql.SQLException

Get a Connection to the database for starting a transaction - defaulting to auto commit being OFF

Parameters:

dbName - database name

Returns:

a Connection to the database for starting a transaction - with auto commit set to false

Throws:

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

java.sql.SQLException - an unexpected SQLException exception

beginTransaction

public static java.sql.Connection beginTransaction(java.lang.String dbName,
                                                   boolean autoCommit)
                                            throws org.apache.torque.TorqueException,
                                                   java.sql.SQLException

Get a Connection to the database for starting a transaction

Parameters:

dbName - database name

autoCommit - true for auto commit

Returns:

a Connection to the database for starting a transaction

Throws:

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

java.sql.SQLException - an unexpected SQLException exception

addAdapters

public static void addAdapters()

Add Database Adapters to Torque

getDB

@Deprecated
public static org.apache.torque.adapter.Adapter getDB(java.lang.String name)
                                                           throws org.apache.torque.TorqueException

Deprecated. use getAdapter(String) instead. This method will be removed in a future version of Torque.

Returns the database adapter for a specific database name.

Parameters:

name - the database name, or null for the default db.

Returns:

The corresponding database adapter.

Throws:

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

getAdapter

public static org.apache.torque.adapter.Adapter getAdapter(java.lang.String name)
                                                    throws org.apache.torque.TorqueException

Returns the database adapter for a specific database name.

Parameters:

name - the database name, or null for the default db.

Returns:

The corresponding database adapter, or null if no database adapter is defined for the given database.

Throws:

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

getTableDotColumn

public static java.lang.String getTableDotColumn(org.apache.torque.map.ColumnMap colMap)

Get tableName + "." + columnName from the ColumnMap

Parameters:

colMap - the ColumnMap

Returns:

tableName + "." + columnName

isColumnAnOracleCLOB

public static boolean isColumnAnOracleCLOB(java.lang.String table,
                                           java.lang.String column,
                                           java.lang.String key)

Is the custom_attrs column is an Oracle CLOB? Return true if it is otherwise false.

Parameters:

table - the database table to check

column - the column in the table to check

key - key of the table

Returns:

the customAttrAnOracleCLOB