org.apache.torque.adapter
Class DBMM

java.lang.Object
  org.apache.torque.adapter.AbstractDBAdapter
      org.apache.torque.adapter.DBMM

All Implemented Interfaces:

java.io.Serializable, DB, IDMethod

public class DBMM
extends AbstractDBAdapter

This is used in order to connect to a MySQL database using the MM drivers. Simply comment the above and uncomment this code below and fill in the appropriate values for DB_NAME, DB_HOST, DB_USER, DB_PASS.

http://www.mysql.com/

"jdbc:mysql://" + DB_HOST + "/" + DB_NAME + "?user=" + DB_USER + "&password=" + DB_PASS;

Version:

$Id: DBMM.java 522044 2007-03-24 16:00:57Z tfischer $

Author:

Jon S. Stevens, Brett McLaughlin, Daniel Rall

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.torque.adapter.DB

ADAPTER_KEY, DRIVER_KEY, LIMIT_STYLE_DB2, LIMIT_STYLE_MYSQL, LIMIT_STYLE_NONE, LIMIT_STYLE_ORACLE, LIMIT_STYLE_POSTGRES, LIMIT_STYLE_SYBASE

Fields inherited from interface org.apache.torque.adapter.IDMethod

AUTO_INCREMENT, ID_BROKER, NATIVE, NO_ID_METHOD, SEQUENCE

Constructor Summary

protected

DBMM() Empty protected constructor.

Method Summary

void	generateLimits(Query query, int offset, int limit) Generate a LIMIT offset, limit clause if offset > 0 or an LIMIT limit clause if limit is > 0 and offset is 0.
java.lang.String	getDateString(java.util.Date date) This method overrides the JDBC escapes used to format dates using a DateFormat.
java.lang.String	getIDMethodSQL(java.lang.Object obj) Returns the SQL to get the database key of the last row inserted, which in this case is SELECT LAST_INSERT_ID().
java.lang.String	getIDMethodType() Returns the constant from the IDMethod interface denoting which type of primary key generation method this type of RDBMS uses.
int	getLimitStyle() Deprecated. This should not be exposed to the outside
java.lang.String	ignoreCase(java.lang.String in) This method is used to ignore case.
void	lockTable(java.sql.Connection con, java.lang.String table) Locks the specified table.
boolean	supportsNativeLimit() Return true for MySQL
boolean	supportsNativeOffset() Return true for MySQL
java.lang.String	toUpperCase(java.lang.String in) This method is used to ignore case.
void	unlockTable(java.sql.Connection con, java.lang.String table) Unlocks the specified table.

Methods inherited from class org.apache.torque.adapter.AbstractDBAdapter

escapeText, getBooleanString, getFunctionClass, getStringDelimiter, ignoreCaseInOrderBy, useEscapeClauseForLike, useIlike

Methods inherited from class java.lang.Object

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

Constructor Detail

DBMM

protected DBMM()

Empty protected constructor.

Method Detail

toUpperCase

public java.lang.String toUpperCase(java.lang.String in)

This method is used to ignore case.

Specified by:

toUpperCase in interface DB

Specified by:

toUpperCase in class AbstractDBAdapter

Parameters:

in - The string to transform to upper case.

Returns:

The upper case string.

ignoreCase

public java.lang.String ignoreCase(java.lang.String in)

This method is used to ignore case.

Specified by:

ignoreCase in interface DB

Specified by:

ignoreCase in class AbstractDBAdapter

Parameters:

in - The string whose case to ignore.

Returns:

The string in a case that can be ignored.

getIDMethodType

public java.lang.String getIDMethodType()

Description copied from class: AbstractDBAdapter

Returns the constant from the IDMethod interface denoting which type of primary key generation method this type of RDBMS uses.

Specified by:

getIDMethodType in interface DB

Specified by:

getIDMethodType in class AbstractDBAdapter

Returns:

IDMethod constant

See Also:

DB.getIDMethodType()

getIDMethodSQL

public java.lang.String getIDMethodSQL(java.lang.Object obj)

Returns the SQL to get the database key of the last row inserted, which in this case is SELECT LAST_INSERT_ID().

Specified by:

getIDMethodSQL in interface DB

Specified by:

getIDMethodSQL in class AbstractDBAdapter

Parameters:

obj - Information used for key generation.

Returns:

The most recently inserted database key.

See Also:

DB.getIDMethodSQL(Object obj)

lockTable

public void lockTable(java.sql.Connection con,
                      java.lang.String table)
               throws java.sql.SQLException

Locks the specified table.

Specified by:

lockTable in interface DB

Specified by:

lockTable in class AbstractDBAdapter

Parameters:

con - The JDBC connection to use.

table - The name of the table to lock.

Throws:

java.sql.SQLException - No Statement could be created or executed.

unlockTable

public void unlockTable(java.sql.Connection con,
                        java.lang.String table)
                 throws java.sql.SQLException

Unlocks the specified table.

Specified by:

unlockTable in interface DB

Specified by:

unlockTable in class AbstractDBAdapter

Parameters:

con - The JDBC connection to use.

table - The name of the table to unlock.

Throws:

java.sql.SQLException - No Statement could be created or executed.

generateLimits

public void generateLimits(Query query,
                           int offset,
                           int limit)

Generate a LIMIT offset, limit clause if offset > 0 or an LIMIT limit clause if limit is > 0 and offset is 0.

Specified by:

generateLimits in interface DB

Overrides:

generateLimits in class AbstractDBAdapter

Parameters:

query - The query to modify

offset - the offset Value

limit - the limit Value

getLimitStyle

public int getLimitStyle()

Deprecated. This should not be exposed to the outside

This method is used to chek whether the database supports limiting the size of the resultset.

Specified by:

getLimitStyle in interface DB

Overrides:

getLimitStyle in class AbstractDBAdapter

Returns:

LIMIT_STYLE_MYSQL.

supportsNativeLimit

public boolean supportsNativeLimit()

Return true for MySQL

Specified by:

supportsNativeLimit in interface DB

Overrides:

supportsNativeLimit in class AbstractDBAdapter

Returns:

True if the database natively supports limiting the size of the resultset.

See Also:

AbstractDBAdapter.supportsNativeLimit()

supportsNativeOffset

public boolean supportsNativeOffset()

Return true for MySQL

Specified by:

supportsNativeOffset in interface DB

Overrides:

supportsNativeOffset in class AbstractDBAdapter

Returns:

True if the database natively supports returning results starting at an offset position other than 0.

See Also:

AbstractDBAdapter.supportsNativeOffset()

getDateString

public java.lang.String getDateString(java.util.Date date)

This method overrides the JDBC escapes used to format dates using a DateFormat. As of version 2.0.11, the MM JDBC driver does not implement JDBC 3.0 escapes.

Specified by:

getDateString in interface DB

Overrides:

getDateString in class AbstractDBAdapter

Parameters:

date - the date to format

Returns:

The properly formatted date String.