org.apache.torque.adapter
Class DBFirebird

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

All Implemented Interfaces:

java.io.Serializable, DB, IDMethod

public class DBFirebird
extends AbstractDBAdapter

This code should be used for a Firebird database pool.

Version:

$Id: DBInterbase.java 239630 2005-08-24 12:25:32Z henning $

Author:

Joerg Friedrich

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

DBFirebird()

Method Summary

boolean	escapeText() This method is for the SqlExpression.quoteAndEscape rules.
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 SQL used to get the most recently inserted primary key.
java.lang.String	getIDMethodType() Returns the constant from the IDMethod interface denoting which type of primary key generation method this type of RDBMS uses.
java.lang.String	ignoreCase(java.lang.String in) This method is used to ignore case.
java.lang.String	ignoreCaseInOrderBy(java.lang.String in) This method is used to ignore case in an ORDER BY clause.
void	lockTable(java.sql.Connection con, java.lang.String table) Locks the specified table.
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.
boolean	useEscapeClauseForLike() Whether an escape clause in like should be used.

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

generateLimits, getBooleanString, getFunctionClass, getLimitStyle, getStringDelimiter, supportsNativeLimit, supportsNativeOffset, useIlike

Methods inherited from class java.lang.Object

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

Constructor Detail

DBFirebird

public DBFirebird()

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.

ignoreCaseInOrderBy

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

This method is used to ignore case in an ORDER BY clause. Usually it is the same as ignoreCase, but some databases (Interbase for example) does not use the same SQL in ORDER BY and other clauses.

Specified by:

ignoreCaseInOrderBy in interface DB

Overrides:

ignoreCaseInOrderBy 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)

Description copied from class: AbstractDBAdapter

Returns SQL used to get the most recently inserted primary key. Databases which have no support for this return null.

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.

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.

escapeText

public boolean escapeText()

This method is for the SqlExpression.quoteAndEscape rules. The rule is, any string in a SqlExpression with a BACKSLASH will either be changed to "\\" (if the method returns true) or left as "\" (if the method returns false).

Specified by:

escapeText in interface DB

Overrides:

escapeText in class AbstractDBAdapter

Returns:

false.

useEscapeClauseForLike

public boolean useEscapeClauseForLike()

Whether an escape clause in like should be used. Example : select * from AUTHOR where AUTHOR.NAME like '\_%' ESCAPE '\'; Firebird needs this, so this implementation always returns true.

Specified by:

useEscapeClauseForLike in interface DB

Overrides:

useEscapeClauseForLike in class AbstractDBAdapter

Returns:

whether the escape clause should be appended or not.