org.apache.empire.db.oracle

Class DBDatabaseDriverOracle

java.lang.Object

org.apache.empire.db.DBDatabaseDriver

org.apache.empire.db.oracle.DBDatabaseDriverOracle

All Implemented Interfaces:

Serializable

public class DBDatabaseDriverOracle
extends DBDatabaseDriver

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBDatabaseDriverOracle.BooleanType

Nested classes/interfaces inherited from class org.apache.empire.db.DBDatabaseDriver

DBDatabaseDriver.DBSeqTable, DBDatabaseDriver.DBSetGenKeys

Field Summary

Fields inherited from class org.apache.empire.db.DBDatabaseDriver

ddlColumnDefaults, GENERAL_SQL_KEYWORDS, ILLEGAL_NAME_CHARS, reservedSQLKeywords, 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

Constructors

Constructor and Description
DBDatabaseDriverOracle() Constructor for the Oracle database driver.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnableRelationStmt(DBRelation r, boolean enable, DBSQLScript script) Appends a statement to enable or disable a foreign key relation. The default is to drop or create the relation Override this method to provide different behavior for your database.
void	checkDatabase(DBDatabase db, String owner, Connection conn) Checks whether the database definition matches the real database structure.
DBCommand	createCommand(DBDatabase db) Creates a new Oracle command object.
String	extractErrorMessage(SQLException sqle) Extracts native error message of an sqlExeption.
DBDatabaseDriverOracle.BooleanType	getBooleanType()
String	getConvertPhrase(DataType destType, DataType srcType, Object format) Returns a data type convertion phrase template for this driver The returned template must contain a '?' which will be replaced by a column expression.
void	getDDLScript(DBCmdType type, DBObject dbo, DBSQLScript script) Appends the required DLL commands to create, drop or alter an object to the supplied DBDQLScript.
Object	getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn) 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).
Object	getResultValue(ResultSet rset, int columnIndex, DataType dataType) Gets the value of a sql ResultSet.
String	getSQLPhrase(int phrase) Gets an sql phrase template for this database system.
Timestamp	getUpdateTimestamp(Connection conn) Overridden.
boolean	isOracle8Compatibilty()
boolean	isSupported(DBDriverFeature type) Returns whether or not a particular feature is supported by this driver
void	setBooleanType(DBDatabaseDriverOracle.BooleanType booleanType)
void	setOracle8Compatibilty(boolean oracle8Compatibilty)

Methods inherited from class org.apache.empire.db.DBDatabaseDriver

addStatementParam, appendElementName, appendElementName, appendSQLTextValue, attachDatabase, close, createCombinedCommand, detachDatabase, detectQuoteName, executeBatch, executeQuery, executeSQL, getColumnAutoValue, getSQLDateTimeString, getSQLNumberString, getSQLTextString, getValueString, isDDLColumnDefaults, prepareStatement, setDDLColumnDefaults, stringToBoolean

Methods inherited from class java.lang.Object

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

Constructor Detail

DBDatabaseDriverOracle

public DBDatabaseDriverOracle()

Constructor for the Oracle database driver.

Method Detail

isOracle8Compatibilty

public boolean isOracle8Compatibilty()

setOracle8Compatibilty

public void setOracle8Compatibilty(boolean oracle8Compatibilty)

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 requested 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 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 String getConvertPhrase(DataType destType,
                      DataType srcType,
                      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 String extractErrorMessage(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 Object getResultValue(ResultSet rset,
                    int columnIndex,
                    DataType dataType)
                      throws 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:

SQLException - if a database access error occurs

getNextSequenceValue

public Object getNextSequenceValue(DBDatabase db,
                          String seqName,
                          int minValue,
                          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 minimum 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)

getUpdateTimestamp

public Timestamp getUpdateTimestamp(Connection conn)

Overridden. Returns a timestamp that is used for record updates created by the database server.

Overrides:

getUpdateTimestamp in class DBDatabaseDriver

Parameters:

conn - the connection that might be used

Returns:

the current date and time of the database server.

getDDLScript

public void getDDLScript(DBCmdType type,
                DBObject dbo,
                DBSQLScript script)

Description copied from class: DBDatabaseDriver

Appends the required DLL commands to create, drop or alter an object to the supplied DBDQLScript.

Overrides:

getDDLScript in class DBDatabaseDriver

Parameters:

type - operation to perform (CREATE, DROP, ALTER)

dbo - the object for which to perform the operation (DBDatabase, DBTable, DBView, DBColumn, DBRelation)

script - the script to which to add the DDL command(s)

See Also:

DBDatabaseDriver.getDDLScript(DBCmdType, DBObject, DBSQLScript)

addEnableRelationStmt

public void addEnableRelationStmt(DBRelation r,
                         boolean enable,
                         DBSQLScript script)

Description copied from class: DBDatabaseDriver

Appends a statement to enable or disable a foreign key relation.
The default is to drop or create the relation Override this method to provide different behavior for your database.

Overrides:

addEnableRelationStmt in class DBDatabaseDriver

Parameters:

r - the foreign key relation which should be enabled or disabled

enable - true to enable the relation or false to disable

script - the script to which to add the DDL command(s)

See Also:

DBDatabaseDriver.addEnableRelationStmt(DBRelation, boolean, DBSQLScript)

checkDatabase

public void checkDatabase(DBDatabase db,
                 String owner,
                 Connection conn)

Checks whether the database definition matches the real database structure.

Overrides:

checkDatabase in class DBDatabaseDriver

Parameters:

db - the database

owner - the owner

conn - the connection