oracle.toplink.essentials.platform.database.oracle

Class OraclePlatform

java.lang.Object

oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

oracle.toplink.essentials.internal.databaseaccess.DatabasePlatform

oracle.toplink.essentials.platform.database.DatabasePlatform

oracle.toplink.essentials.platform.database.oracle.OraclePlatform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Platform

public class OraclePlatform
extends DatabasePlatform

Purpose: Provides Oracle specific behaviour.

Responsibilities:

• Native SQL for byte[], Date, Time, & Timestamp.
• Native sequencing named sequences.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.databaseaccess.DatabasePlatform

classTypes, cursorCode, fieldTypes, shouldBindAllParameters, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldTrimStrings, statementCacheSize, stringBindingSize, supportsAutoCommit, transactionIsolation, usesByteArrayBinding, usesNativeSQL, usesStreamsForBinding, usesStringBinding

Fields inherited from class oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

conversionManager, dataTypesConvertedFromAClass, dataTypesConvertedToAClass, defaultSequence, platformOperators, sequences, tableQualifier, timestampQuery

Constructor Summary

Constructors

Constructor and Description
OraclePlatform()

Method Summary

Modifier and Type	Method and Description
boolean	allowsSizeInProcedureArguments() INTERNAL: Used for sp defs.
protected void	appendByteArray(byte[] bytes, java.io.Writer writer) INTERNAL: If using native SQL then print a byte[] literally as a hex string otherwise use ODBC format as provided in DatabasePlatform.
protected void	appendCalendar(java.util.Calendar calendar, java.io.Writer writer) INTERNAL: Appends an Oracle specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format.
protected void	appendDate(java.sql.Date date, java.io.Writer writer) INTERNAL: Appends an Oracle specific date if usesNativeSQL is true otherwise use the ODBC format.
protected void	appendTime(java.sql.Time time, java.io.Writer writer) INTERNAL: Appends an Oracle specific time if usesNativeSQL is true otherwise use the ODBC format.
protected void	appendTimestamp(java.sql.Timestamp timestamp, java.io.Writer writer) INTERNAL: Appends an Oracle specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format.
ExpressionOperator	atan2Operator() INTERNAL: Build operator.
DatabaseCall	buildCallWithReturning(SQLCall sqlCall, java.util.Vector returnFields) INTERNAL Returns null unless the platform supports call with returning
protected java.util.Hashtable	buildClassTypes() Return the mapping of class types to database types for the schema framework.
protected java.util.Hashtable	buildFieldTypes() Return the mapping of class types to database types for the schema framework.
ValueReadQuery	buildSelectQueryForNativeSequence(java.lang.String seqName, java.lang.Integer size) INTERNAL: Produce a DataReadQuery which updates(!) the sequence number in the db and returns it.
boolean	canBuildCallWithReturning() INTERNAL Indicates whether the platform can build call with returning.
protected ExpressionOperator	currentDateOperator()
protected ExpressionOperator	currentTimeOperator()
java.lang.String	getAssignmentString() INTERNAL Used for stored function calls.
java.lang.String	getBatchBeginString() INTERNAL: Used for batch writing and sp defs.
java.lang.String	getBatchEndString() INTERNAL: Used for batch writing and sp defs.
java.lang.String	getJDBCOuterJoinString() Returns the JDBC outer join operator for SELECT statements.
int	getMaxFieldNameSize() INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.
java.util.Vector	getNativeTableInfo(java.lang.String table, java.lang.String creator, AbstractSession session) INTERNAL: Return the catalog information through using the native SQL catalog selects.
java.lang.Object	getObjectFromResultSet(java.sql.ResultSet resultSet, int columnNumber, int type) INTERNAL: Get a timestamp value from a result set.
java.lang.String	getProcedureArgumentSetter() INTERNAL: Used for sp calls.
java.lang.String	getProcedureCallHeader() INTERNAL: Used for sp calls.
java.lang.String	getProcedureCallTail() INTERNAL: Used for sp calls.
protected java.lang.String	getQualifiedSequenceName(java.lang.String seqName) INTERNAL: Prepend sequence name with table qualifier (if any)
java.lang.String	getSelectForUpdateString() INTERNAL:
java.lang.String	getStoredProcedureParameterPrefix() INTERNAL:
java.lang.String	getStoredProcedureTerminationToken() INTERNAL:
ValueReadQuery	getSystemChangeNumberQuery() INTERNAL: The query to select the current system change number from Oracle.
ValueReadQuery	getTimestampQuery() INTERNAL: This method returns the query to select the timestamp from the server for Oracle.
protected void	initializePlatformOperators() INTERNAL: Initialize any platform-specific operators
boolean	isOracle()
protected ExpressionOperator	logOperator() INTERNAL: Create the log operator for this platform
java.util.Hashtable	maximumNumericValues() INTERNAL: Builds a table of maximum numeric values keyed on java class.
java.util.Hashtable	minimumNumericValues() INTERNAL: Builds a table of minimum numeric values keyed on java class.
protected ExpressionOperator	operatorLocate() INTERNAL: Override the default locate operator
protected ExpressionOperator	operatorLocate2() INTERNAL: Override the default locate operator
protected ExpressionOperator	operatorOuterJoin() INTERNAL: Create the outer join operator for this platform
void	printFieldNullClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'NULL' constraint clause to a writer.
java.lang.String	serverTimestampString() INTERNAL: Return the current date and time from the server.
void	setPrimitiveParameterValue(java.sql.PreparedStatement statement, int index, java.lang.Object parameter) INTERNAL: Set a primitive parameter.
boolean	shouldPrintOuterJoinInWhereClause() INTERNAL: Some database require outer joins to be given in the where clause, others require it in the from clause.
boolean	shouldUseJDBCOuterJoinSyntax() INTERNAL: JDBC defines and outer join syntax, many drivers do not support this.
boolean	supportsNativeSequenceNumbers() INTERNAL: Return true if the receiver uses host sequence numbers, generated on the database.
boolean	supportsSelectForUpdateNoWait() INTERNAL: Returns true if the database supports SQL syntax not to wait on a SELECT..FOR UPADTE (i.e.
boolean	supportsStoredFunctions() INTERNAL:
protected ExpressionOperator	todayOperator() INTERNAL: Create the sysdate operator for this platform

Methods inherited from class oracle.toplink.essentials.internal.databaseaccess.DatabasePlatform

appendBoolean, appendLiteralToCall, appendLiteralToCallWithBinding, appendNumber, appendParameter, appendParameterInternal, appendString, autoCommit, beginTransaction, buildSelectQueryForNativeSequence, commitTransaction, convertToDatabaseType, copyInto, createPlatformDefaultSequence, dontBindUpdateAllQueryUsingTempTables, executeStoredProcedure, getBatchDelimiterString, getClassTypes, getConstraintDeletionString, getCreateTempTableSqlBodyForTable, getCreateTempTableSqlPrefix, getCreateTempTableSqlSuffix, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getInOutputProcedureToken, getJDBCType, getJDBCType, getJdbcTypeName, getMaxForeignKeyNameSize, getMaxUniqueKeyNameSize, getOutputProcedureToken, getProcedureArgumentString, getProcedureAsString, getProcedureBeginString, getProcedureEndString, getQualifiedSequenceTableName, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStringBindingSize, getTempTableForTable, getTransactionIsolation, isInformixOuterJoin, isNullAllowedInSelectClause, printFieldIdentityClause, printFieldIdentityClause, printFieldNotNullClause, printFieldTypeSize, printFieldUnique, printValuelist, printValuelist, processResultSet, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTypeNameToRegisterOutputParameter, rollbackTransaction, setClassTypes, setCursorCode, setFieldTypes, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTransactionIsolation, setUsesByteArrayBinding, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAcquireSequenceValueAfterInsert, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldNativeSequenceAcquireValueAfterInsert, shouldNativeSequenceUseTransaction, shouldOptimizeDataConversion, shouldPrintConstraintNameAfter, shouldPrintInOutputTokenBeforeType, shouldPrintOutputTokenAtStart, shouldPrintOutputTokenBeforeType, shouldTempTableSpecifyPrimaryKeys, shouldTrimStrings, supportsAutoCommit, supportsForeignKeyConstraints, supportsGlobalTempTables, supportsLocalTempTables, supportsPrimaryKeyConstraint, supportsTempTables, supportsUniqueKeyConstraints, usesByteArrayBinding, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, writeParameterMarker, writeUpdateOriginalFromTempTableSql

Methods inherited from class oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

addOperator, addSequence, clone, convertObject, createSequences, getConversionManager, getCustomModifyValueForCall, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getDefaultSequenceToWrite, getOperator, getPlatformOperators, getSequence, getSequences, getSequencesToWrite, getTableQualifier, getTimestampFromServer, hasDefaultSequence, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isHSQL, isInformix, isMySQL, isODBC, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isTimesTen, platformSpecificSequencingInitialization, removeAllSequences, removeSequence, sequencesAfterCloneCleanup, setConversionManager, setDefaultSequence, setSequences, setTableQualifier, setTimestampQuery, shouldUseCustomModifyForCall, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

OraclePlatform

public OraclePlatform()

Method Detail

allowsSizeInProcedureArguments

public boolean allowsSizeInProcedureArguments()

INTERNAL: Used for sp defs.

Overrides:

allowsSizeInProcedureArguments in class DatabasePlatform

appendByteArray

protected void appendByteArray(byte[] bytes,
                               java.io.Writer writer)
                        throws java.io.IOException

INTERNAL: If using native SQL then print a byte[] literally as a hex string otherwise use ODBC format as provided in DatabasePlatform.

Overrides:

appendByteArray in class DatabasePlatform

Throws:

java.io.IOException

appendDate

protected void appendDate(java.sql.Date date,
                          java.io.Writer writer)
                   throws java.io.IOException

INTERNAL: Appends an Oracle specific date if usesNativeSQL is true otherwise use the ODBC format. Native FORMAT: to_date('1997-11-06','yyyy-mm-dd')

Overrides:

appendDate in class DatabasePlatform

Throws:

java.io.IOException

appendTime

protected void appendTime(java.sql.Time time,
                          java.io.Writer writer)
                   throws java.io.IOException

INTERNAL: Appends an Oracle specific time if usesNativeSQL is true otherwise use the ODBC format. Native FORMAT: to_date(#####, 'sssss').

Overrides:

appendTime in class DatabasePlatform

Throws:

java.io.IOException

appendTimestamp

protected void appendTimestamp(java.sql.Timestamp timestamp,
                               java.io.Writer writer)
                        throws java.io.IOException

INTERNAL: Appends an Oracle specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format. Native Format: to_date ('1997-11-06 10:35:45.0' , 'yyyy-mm-dd hh:mm:ss.n')

Overrides:

appendTimestamp in class DatabasePlatform

Throws:

java.io.IOException

appendCalendar

protected void appendCalendar(java.util.Calendar calendar,
                              java.io.Writer writer)
                       throws java.io.IOException

INTERNAL: Appends an Oracle specific Timestamp, if usesNativeSQL is true otherwise use the ODBC format. Native Format: to_date ('1997-11-06 10:35:45.0' , 'yyyy-mm-dd hh:mm:ss.n')

Overrides:

appendCalendar in class DatabasePlatform

Throws:

java.io.IOException

atan2Operator

public ExpressionOperator atan2Operator()

INTERNAL: Build operator.

buildFieldTypes

protected java.util.Hashtable buildFieldTypes()

Description copied from class: DatabasePlatform

Return the mapping of class types to database types for the schema framework.

Overrides:

buildFieldTypes in class DatabasePlatform

buildClassTypes

protected java.util.Hashtable buildClassTypes()

Return the mapping of class types to database types for the schema framework.

Overrides:

buildClassTypes in class DatabasePlatform

buildCallWithReturning

public DatabaseCall buildCallWithReturning(SQLCall sqlCall,
                                           java.util.Vector returnFields)

INTERNAL Returns null unless the platform supports call with returning

Overrides:

buildCallWithReturning in class DatabasePlatform

canBuildCallWithReturning

public boolean canBuildCallWithReturning()

INTERNAL Indicates whether the platform can build call with returning. In case this method returns true, buildCallWithReturning method may be called.

Overrides:

canBuildCallWithReturning in class DatabasePlatform

getAssignmentString

public java.lang.String getAssignmentString()

INTERNAL Used for stored function calls.

Overrides:

getAssignmentString in class DatabasePlatform

getBatchBeginString

public java.lang.String getBatchBeginString()

INTERNAL: Used for batch writing and sp defs.

Overrides:

getBatchBeginString in class DatabasePlatform

getBatchEndString

public java.lang.String getBatchEndString()

INTERNAL: Used for batch writing and sp defs.

Overrides:

getBatchEndString in class DatabasePlatform

getJDBCOuterJoinString

public java.lang.String getJDBCOuterJoinString()

Returns the JDBC outer join operator for SELECT statements. Overwrites the default implementation, as some Oracle versions seem to require the syntax given here.

Overrides:

getJDBCOuterJoinString in class DatabasePlatform

getMaxFieldNameSize

public int getMaxFieldNameSize()

INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.

Overrides:

getMaxFieldNameSize in class DatabasePlatform

getNativeTableInfo

public java.util.Vector getNativeTableInfo(java.lang.String table,
                                           java.lang.String creator,
                                           AbstractSession session)

INTERNAL: Return the catalog information through using the native SQL catalog selects. This is required because many JDBC driver do not support meta-data. Willcards can be passed as arguments.

getProcedureArgumentSetter

public java.lang.String getProcedureArgumentSetter()

INTERNAL: Used for sp calls.

Overrides:

getProcedureArgumentSetter in class DatabasePlatform

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()

INTERNAL: Used for sp calls.

Overrides:

getProcedureCallHeader in class DatabasePlatform

getProcedureCallTail

public java.lang.String getProcedureCallTail()

INTERNAL: Used for sp calls.

Overrides:

getProcedureCallTail in class DatabasePlatform

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()

INTERNAL:

Overrides:

getSelectForUpdateString in class DatabasePlatform

getStoredProcedureParameterPrefix

public java.lang.String getStoredProcedureParameterPrefix()

INTERNAL:

Overrides:

getStoredProcedureParameterPrefix in class DatabasePlatform

getStoredProcedureTerminationToken

public java.lang.String getStoredProcedureTerminationToken()

INTERNAL:

Overrides:

getStoredProcedureTerminationToken in class DatabasePlatform

getSystemChangeNumberQuery

public ValueReadQuery getSystemChangeNumberQuery()

INTERNAL: The query to select the current system change number from Oracle. In order to execute this query a database administrator may need to grant execute permission on pl/sql package DBMS_FLASHBACK.

getTimestampQuery

public ValueReadQuery getTimestampQuery()

INTERNAL: This method returns the query to select the timestamp from the server for Oracle.

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class DatasourcePlatform

getObjectFromResultSet

public java.lang.Object getObjectFromResultSet(java.sql.ResultSet resultSet,
                                               int columnNumber,
                                               int type)
                                        throws java.sql.SQLException

INTERNAL: Get a timestamp value from a result set. Overrides the default behavior to specifically return a timestamp. Added to overcome an issue with the oracle 9.0.1.4 JDBC driver.

Overrides:

getObjectFromResultSet in class DatabasePlatform

Throws:

java.sql.SQLException

See Also:

oracle.toplink.essentials.oraclespecific.Oracle9Platform

initializePlatformOperators

protected void initializePlatformOperators()

INTERNAL: Initialize any platform-specific operators

Overrides:

initializePlatformOperators in class DatasourcePlatform

isOracle

public boolean isOracle()

Specified by:

isOracle in interface Platform

Overrides:

isOracle in class DatasourcePlatform

logOperator

protected ExpressionOperator logOperator()

INTERNAL: Create the log operator for this platform

maximumNumericValues

public java.util.Hashtable maximumNumericValues()

INTERNAL: Builds a table of maximum numeric values keyed on java class. This is used for type testing but might also be useful to end users attempting to sanitize values.

NOTE: BigInteger & BigDecimal maximums are dependent upon their precision & Scale

Overrides:

maximumNumericValues in class DatabasePlatform

minimumNumericValues

public java.util.Hashtable minimumNumericValues()

INTERNAL: Builds a table of minimum numeric values keyed on java class. This is used for type testing but might also be useful to end users attempting to sanitize values.

NOTE: BigInteger & BigDecimal minimums are dependent upon their precision & Scale

Overrides:

minimumNumericValues in class DatabasePlatform

buildSelectQueryForNativeSequence

public ValueReadQuery buildSelectQueryForNativeSequence(java.lang.String seqName,
                                                        java.lang.Integer size)

INTERNAL: Produce a DataReadQuery which updates(!) the sequence number in the db and returns it. Currently implemented on Oracle only.

Overrides:

buildSelectQueryForNativeSequence in class DatabasePlatform

Parameters:

sequenceName - Name known by Oracle to be a defined sequence

getQualifiedSequenceName

protected java.lang.String getQualifiedSequenceName(java.lang.String seqName)

INTERNAL: Prepend sequence name with table qualifier (if any)

operatorOuterJoin

protected ExpressionOperator operatorOuterJoin()

INTERNAL: Create the outer join operator for this platform

operatorLocate

protected ExpressionOperator operatorLocate()

INTERNAL: Override the default locate operator

operatorLocate2

protected ExpressionOperator operatorLocate2()

INTERNAL: Override the default locate operator

printFieldNullClause

public void printFieldNullClause(java.io.Writer writer)
                          throws ValidationException

INTERNAL: Append the receiver's field 'NULL' constraint clause to a writer.

Overrides:

printFieldNullClause in class DatabasePlatform

Throws:

ValidationException

serverTimestampString

public java.lang.String serverTimestampString()

INTERNAL: Return the current date and time from the server.

setPrimitiveParameterValue

public void setPrimitiveParameterValue(java.sql.PreparedStatement statement,
                                       int index,
                                       java.lang.Object parameter)
                                throws java.sql.SQLException

INTERNAL: Set a primitive parameter.

Overrides:

setPrimitiveParameterValue in class DatabasePlatform

Throws:

java.sql.SQLException

shouldPrintOuterJoinInWhereClause

public boolean shouldPrintOuterJoinInWhereClause()

INTERNAL: Some database require outer joins to be given in the where clause, others require it in the from clause.

Overrides:

shouldPrintOuterJoinInWhereClause in class DatabasePlatform

shouldUseJDBCOuterJoinSyntax

public boolean shouldUseJDBCOuterJoinSyntax()

INTERNAL: JDBC defines and outer join syntax, many drivers do not support this. So we normally avoid it.

Overrides:

shouldUseJDBCOuterJoinSyntax in class DatabasePlatform

supportsNativeSequenceNumbers

public boolean supportsNativeSequenceNumbers()

INTERNAL: Return true if the receiver uses host sequence numbers, generated on the database. Oracle does through global sequence objects.

Overrides:

supportsNativeSequenceNumbers in class DatabasePlatform

supportsStoredFunctions

public boolean supportsStoredFunctions()

INTERNAL:

Overrides:

supportsStoredFunctions in class DatabasePlatform

supportsSelectForUpdateNoWait

public boolean supportsSelectForUpdateNoWait()

INTERNAL: Returns true if the database supports SQL syntax not to wait on a SELECT..FOR UPADTE (i.e. In Oracle adding NOWAIT to the end will accomplish this)

todayOperator

protected ExpressionOperator todayOperator()

INTERNAL: Create the sysdate operator for this platform

currentDateOperator

protected ExpressionOperator currentDateOperator()

currentTimeOperator

protected ExpressionOperator currentTimeOperator()