org.apache.empire.db.oracle
Class DBDatabaseDriverOracle

java.lang.Object
  extended by org.apache.empire.commons.ErrorObject
      extended by org.apache.empire.db.DBDatabaseDriver
          extended by org.apache.empire.db.oracle.DBDatabaseDriverOracle
All Implemented Interfaces:
ErrorInfo

public class DBDatabaseDriverOracle
extends DBDatabaseDriver

This class provides support for the Oracle database system.
Oracle Version 9 or higher is required.


Nested Class Summary
static class DBDatabaseDriverOracle.BooleanType
           
 
Nested classes/interfaces inherited from class org.apache.empire.db.DBDatabaseDriver
DBDatabaseDriver.DBSeqTable
 
Field Summary
 
Fields inherited from class org.apache.empire.db.DBDatabaseDriver
SQL_BOOLEAN_FALSE, SQL_BOOLEAN_TRUE, SQL_CONCAT_EXPR, SQL_CURRENT_DATE, SQL_CURRENT_DATETIME, SQL_DATABASE_LINK, SQL_DATE_PATTERN, SQL_DATE_TEMPLATE, SQL_DATETIME_PATTERN, SQL_DATETIME_TEMPLATE, SQL_FUNC_ABS, SQL_FUNC_AVG, SQL_FUNC_CEILING, SQL_FUNC_COALESCE, SQL_FUNC_DAY, SQL_FUNC_DECODE, SQL_FUNC_DECODE_ELSE, SQL_FUNC_DECODE_PART, SQL_FUNC_DECODE_SEP, SQL_FUNC_ESCAPE, SQL_FUNC_FLOOR, SQL_FUNC_LENGTH, SQL_FUNC_LOWER, SQL_FUNC_LTRIM, SQL_FUNC_MAX, SQL_FUNC_MIN, SQL_FUNC_MONTH, SQL_FUNC_REPLACE, SQL_FUNC_REVERSE, SQL_FUNC_ROUND, SQL_FUNC_RTRIM, SQL_FUNC_STRINDEX, SQL_FUNC_STRINDEXFROM, SQL_FUNC_SUBSTRING, SQL_FUNC_SUBSTRINGEX, SQL_FUNC_SUM, SQL_FUNC_TRIM, SQL_FUNC_TRUNC, SQL_FUNC_UPPER, SQL_FUNC_YEAR, SQL_NULL_VALUE, SQL_PARAMETER, SQL_QUOTES_CLOSE, SQL_QUOTES_OPEN, SQL_RENAME_COLUMN, SQL_RENAME_TABLE
 
Constructor Summary
DBDatabaseDriverOracle()
          Constructor for the Oracle database driver.
 
Method Summary
 boolean checkDatabase(DBDatabase db, java.lang.String owner, java.sql.Connection conn)
          Checks whether the database defintion matches the real database structure.
 DBCommand createCommand(DBDatabase db)
          Creates a new Oracle command object.
 java.lang.String extractErrorMessage(java.sql.SQLException sqle)
          Extracts native error message of an sqlExeption.
 DBDatabaseDriverOracle.BooleanType getBooleanType()
           
 java.lang.String getConvertPhrase(DataType destType, DataType srcType, java.lang.Object format)
          Returns a data type convertion phrase template for this driver
The returned template must contain a '?'
 boolean getDDLScript(DBCmdType type, DBObject dbo, DBSQLScript script)
          gets an SQL command for creating, modifying or deleting objects in the database (tables, columns, constraints, etc.)
 java.lang.Object getNextSequenceValue(DBDatabase db, java.lang.String seqName, int minValue, java.sql.Connection conn)
          Returns the next value of a named sequence The numbers are used for fields of type DBExpr.DT_AUTOINC.
 java.lang.Object getResultValue(java.sql.ResultSet rset, int columnIndex, DataType dataType)
          Gets the value of a sql ResultSet.
 java.lang.String getSQLPhrase(int phrase)
          Gets an sql phrase template for this database system.
 java.sql.Timestamp getUpdateTimestamp(java.sql.Connection conn)
          Overridden.
 boolean isSupported(DBDriverFeature type)
          Returns whether or not a particular feature is supported by this driver
 void setBooleanType(DBDatabaseDriverOracle.BooleanType booleanType)
           
 
Methods inherited from class org.apache.empire.db.DBDatabaseDriver
appendElementName, appendElementName, executeQuery, executeSQL, getPostInsertAutoIncValue, getValueString, isDDLColumnDefaults, setDDLColumnDefaults
 
Methods inherited from class org.apache.empire.commons.ErrorObject
clearError, getErrorMessage, getErrorParams, getErrorSource, getErrorType, getMessage, hasError, isExceptionsEnabled, setExceptionsEnabled
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DBDatabaseDriverOracle

public DBDatabaseDriverOracle()
Constructor for the Oracle database driver.

Method Detail

getBooleanType

public DBDatabaseDriverOracle.BooleanType getBooleanType()

setBooleanType

public void setBooleanType(DBDatabaseDriverOracle.BooleanType booleanType)

isSupported

public boolean isSupported(DBDriverFeature type)
Returns whether or not a particular feature is supported by this driver

Specified by:
isSupported in class DBDatabaseDriver
Parameters:
type - type of requrested feature. @see DBDriverFeature
Returns:
true if the features is supported or false otherwise

createCommand

public DBCommand createCommand(DBDatabase db)
Creates a new Oracle command object.

Specified by:
createCommand in class DBDatabaseDriver
Parameters:
db - the database for which to create a command object for
Returns:
the new DBCommandOracle object

getSQLPhrase

public java.lang.String getSQLPhrase(int phrase)
Gets an sql phrase template for this database system.

Specified by:
getSQLPhrase in class DBDatabaseDriver
Parameters:
phrase - the identifier of the phrase
Returns:
the phrase template
See Also:
DBDatabaseDriver.getSQLPhrase(int)

getConvertPhrase

public java.lang.String getConvertPhrase(DataType destType,
                                         DataType srcType,
                                         java.lang.Object format)
Description copied from class: DBDatabaseDriver
Returns a data type convertion phrase template for this driver
The returned template must contain a '?' which will be replaced by a column expression.

Specified by:
getConvertPhrase in class DBDatabaseDriver
Parameters:
destType - the target data type
srcType - the source data type
format - additional formatting information (optional)
Returns:
the data conversion phrase template
See Also:
DBDatabaseDriver.getConvertPhrase(DataType, DataType, Object)

extractErrorMessage

public java.lang.String extractErrorMessage(java.sql.SQLException sqle)
Extracts native error message of an sqlExeption.

Overrides:
extractErrorMessage in class DBDatabaseDriver
Parameters:
sqle - the SQLException
Returns:
the error message of the database

getResultValue

public java.lang.Object getResultValue(java.sql.ResultSet rset,
                                       int columnIndex,
                                       DataType dataType)
                                throws java.sql.SQLException
Gets the value of a sql ResultSet. Gives the driver the oportunity to change the value i.e. to simulate missing data types with other types.

Overrides:
getResultValue in class DBDatabaseDriver
Parameters:
rset - the sql Resultset with the current data row
columnIndex - one based column Index of the desired column
dataType - the desired data type
Returns:
the value of the column
Throws:
java.sql.SQLException

getNextSequenceValue

public java.lang.Object getNextSequenceValue(DBDatabase db,
                                             java.lang.String seqName,
                                             int minValue,
                                             java.sql.Connection conn)
Description copied from class: DBDatabaseDriver
Returns the next value of a named sequence The numbers are used for fields of type DBExpr.DT_AUTOINC.
If a driver supports this function it must return true for isSupported(DBDriverFeature.SEQUENCES).

Specified by:
getNextSequenceValue in class DBDatabaseDriver
Parameters:
db - the database
seqName - the name of the sequence
minValue - the minmum value of the sequence
conn - a valid database connection
Returns:
a new unique sequence value or null if an error occurred
See Also:
DBDatabaseDriver.getNextSequenceValue(DBDatabase, String, int, Connection)

getDDLScript

public boolean getDDLScript(DBCmdType type,
                            DBObject dbo,
                            DBSQLScript script)
Description copied from class: DBDatabaseDriver
gets an SQL command for creating, modifying or deleting objects in the database (tables, columns, constraints, etc.)

Overrides:
getDDLScript in class DBDatabaseDriver
See Also:
DBDatabaseDriver.getDDLScript(DBCmdType, DBObject, DBSQLScript)

getUpdateTimestamp

public java.sql.Timestamp getUpdateTimestamp(java.sql.Connection conn)
Overridden. Returns a timestamp that is used for record updates created by the database server.

Overrides:
getUpdateTimestamp in class DBDatabaseDriver
Returns:
the current date and time of the database server.

checkDatabase

public boolean checkDatabase(DBDatabase db,
                             java.lang.String owner,
                             java.sql.Connection conn)
Checks whether the database defintion matches the real database structure.

Overrides:
checkDatabase in class DBDatabaseDriver
Returns:
true if the database defintion matches the real database structure.