oracle.toplink.essentials.platform.database

Class DB2Platform

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.DB2Platform

All Implemented Interfaces:

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

Direct Known Subclasses:

DB2MainframePlatform, DerbyPlatform

public class DB2Platform
extends DatabasePlatform

Purpose: Provides DB2 specific behaviour.

Responsibilities:

• Native SQL for byte[], Date, Time, & Timestamp.
• Support for table qualified names.

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
DB2Platform()

Method Summary

Modifier and Type	Method and Description
protected void	appendByteArray(byte[] bytes, java.io.Writer writer) INTERNAL: Append a byte[] in native DB@ format BLOB(hexString) if usesNativeSQL(), otherwise use ODBC format from DatabasePLatform.
protected void	appendCalendar(java.util.Calendar calendar, java.io.Writer writer) INTERNAL: Append the Timestamp in native format if usesNativeSQL() is true otherwise use ODBC format from DatabasePlatform.
protected void	appendDate(java.sql.Date date, java.io.Writer writer) INTERNAL: Appends the Date in native format if usesNativeSQL() otherwise use ODBC format from DatabasePlatform.
protected void	appendDB2Calendar(java.util.Calendar calendar, java.io.Writer writer) INTERNAL: Write a timestamp in DB2 specific format (yyyy-mm-dd-hh.mm.ss.ffffff).
protected void	appendDB2Date(java.sql.Date date, java.io.Writer writer) INTERNAL: Write a timestamp in DB2 specific format (mm/dd/yyyy).
protected void	appendDB2Timestamp(java.sql.Timestamp timestamp, java.io.Writer writer) INTERNAL: Write a timestamp in DB2 specific format (yyyy-mm-dd-hh.mm.ss.ffffff).
protected void	appendTime(java.sql.Time time, java.io.Writer writer) INTERNAL: Append the Time in Native format if usesNativeSQL() otherwise use ODBC format from DAtabasePlatform.
protected void	appendTimestamp(java.sql.Timestamp timestamp, java.io.Writer writer) INTERNAL: Append the Timestamp in native format if usesNativeSQL() is true otherwise use ODBC format from DatabasePlatform.
protected java.util.Hashtable	buildFieldTypes() Return the mapping of class types to database types for the schema framework.
ValueReadQuery	buildSelectQueryForNativeSequence() INTERNAL: Build the identity query for native sequencing.
protected java.lang.String	getCreateTempTableSqlBodyForTable(DatabaseTable table) INTERNAL:
protected java.lang.String	getCreateTempTableSqlPrefix() INTERNAL:
protected java.lang.String	getCreateTempTableSqlSuffix() INTERNAL:
int	getMaxFieldNameSize() INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.
int	getMaxForeignKeyNameSize() INTERNAL: returns the maximum number of characters that can be used in a foreign key 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.String	getProcedureAsString() INTERNAL: Used for stored procedure defs.
java.lang.String	getProcedureBeginString() INTERNAL: Used for stored procedure defs.
java.lang.String	getProcedureCallHeader() INTERNAL: Used for sp calls.
java.lang.String	getProcedureEndString() INTERNAL: Used for stored procedure defs.
java.lang.String	getSelectForUpdateString() INTERNAL:
DatabaseTable	getTempTableForTable(DatabaseTable table) INTERNAL:
ValueReadQuery	getTimestampQuery() INTERNAL: This method returns the query to select the timestamp from the server for DB2.
protected void	initializePlatformOperators() INTERNAL: Initialize any platform-specific operators
boolean	isDB2()
boolean	isNullAllowedInSelectClause() INTERNAL: Override this if the platform cannot handle NULL in select clause.
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.
void	printFieldIdentityClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'identity' constraint clause to a writer
boolean	shouldBindLiterals() INTERNAL Allows platform to choose whether to bind literals in DatabaseCalls or not.
boolean	shouldIgnoreException(java.sql.SQLException exception) INTERNAL: Allow for the platform to ignore exceptions.
boolean	shouldNativeSequenceAcquireValueAfterInsert() INTERNAL: If native sequencing is being used on DB2 then the values must be retrieved after the insert.
boolean	shouldPrintOutputTokenAtStart() INTERNAL: This is required in the construction of the stored procedures with output parameters
boolean	shouldUseJDBCOuterJoinSyntax() INTERNAL: JDBC defines and outer join syntax, many drivers do not support this.
boolean	supportsGlobalTempTables() INTERNAL:
boolean	supportsNativeSequenceNumbers() Return true if the receiver uses host sequence numbers, generated on the database.
void	writeParameterMarker(java.io.Writer writer, ParameterExpression parameter)

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

allowsSizeInProcedureArguments, appendBoolean, appendLiteralToCall, appendLiteralToCallWithBinding, appendNumber, appendParameter, appendParameterInternal, appendString, autoCommit, beginTransaction, buildCallWithReturning, buildClassTypes, buildSelectQueryForNativeSequence, canBuildCallWithReturning, commitTransaction, convertToDatabaseType, copyInto, createPlatformDefaultSequence, dontBindUpdateAllQueryUsingTempTables, executeStoredProcedure, getAssignmentString, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getClassTypes, getConstraintDeletionString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getInOutputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJdbcTypeName, getMaxUniqueKeyNameSize, getObjectFromResultSet, getOutputProcedureToken, getProcedureArgumentSetter, getProcedureArgumentString, getProcedureCallTail, getQualifiedSequenceTableName, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getTransactionIsolation, isInformixOuterJoin, printFieldIdentityClause, printFieldNotNullClause, printFieldNullClause, printFieldTypeSize, printFieldUnique, printValuelist, printValuelist, processResultSet, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTypeNameToRegisterOutputParameter, rollbackTransaction, setClassTypes, setCursorCode, setFieldTypes, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setParameterValueInDatabaseCall, setPrimitiveParameterValue, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTransactionIsolation, setUsesByteArrayBinding, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAcquireSequenceValueAfterInsert, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldNativeSequenceUseTransaction, shouldOptimizeDataConversion, shouldPrintConstraintNameAfter, shouldPrintInOutputTokenBeforeType, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenBeforeType, shouldTempTableSpecifyPrimaryKeys, shouldTrimStrings, supportsAutoCommit, supportsForeignKeyConstraints, supportsLocalTempTables, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueKeyConstraints, usesByteArrayBinding, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, 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, isDBase, isDerby, isHSQL, isInformix, isMySQL, isODBC, isOracle, 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

DB2Platform

public DB2Platform()

Method Detail

appendByteArray

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

INTERNAL: Append a byte[] in native DB@ format BLOB(hexString) if usesNativeSQL(), otherwise use ODBC format from 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 the Date in native format if usesNativeSQL() otherwise use ODBC format from DatabasePlatform. Native format: 'mm/dd/yyyy'

Overrides:

appendDate in class DatabasePlatform

Throws:

java.io.IOException

appendDB2Date

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

INTERNAL: Write a timestamp in DB2 specific format (mm/dd/yyyy).

Throws:

java.io.IOException

appendDB2Timestamp

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

INTERNAL: Write a timestamp in DB2 specific format (yyyy-mm-dd-hh.mm.ss.ffffff).

Throws:

java.io.IOException

appendDB2Calendar

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

INTERNAL: Write a timestamp in DB2 specific format (yyyy-mm-dd-hh.mm.ss.ffffff).

Throws:

java.io.IOException

appendTime

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

INTERNAL: Append the Time in Native format if usesNativeSQL() otherwise use ODBC format from DAtabasePlatform. Native Format: 'hh:mm:ss'

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: Append the Timestamp in native format if usesNativeSQL() is true otherwise use ODBC format from DatabasePlatform. Native format: 'YYYY-MM-DD-hh.mm.ss.SSSSSS'

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: Append the Timestamp in native format if usesNativeSQL() is true otherwise use ODBC format from DatabasePlatform. Native format: 'YYYY-MM-DD-hh.mm.ss.SSSSSS'

Overrides:

appendCalendar in class DatabasePlatform

Throws:

java.io.IOException

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

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

getMaxForeignKeyNameSize

public int getMaxForeignKeyNameSize()

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

Overrides:

getMaxForeignKeyNameSize 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.

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()

INTERNAL: Used for sp calls.

Overrides:

getProcedureCallHeader in class DatabasePlatform

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()

INTERNAL:

Overrides:

getSelectForUpdateString in class DatabasePlatform

getProcedureEndString

public java.lang.String getProcedureEndString()

INTERNAL: Used for stored procedure defs.

Overrides:

getProcedureEndString in class DatabasePlatform

getProcedureBeginString

public java.lang.String getProcedureBeginString()

INTERNAL: Used for stored procedure defs.

Overrides:

getProcedureBeginString in class DatabasePlatform

getProcedureAsString

public java.lang.String getProcedureAsString()

INTERNAL: Used for stored procedure defs.

Overrides:

getProcedureAsString in class DatabasePlatform

shouldPrintOutputTokenAtStart

public boolean shouldPrintOutputTokenAtStart()

INTERNAL: This is required in the construction of the stored procedures with output parameters

Overrides:

shouldPrintOutputTokenAtStart in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

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

Specified by:

getTimestampQuery in interface Platform

Overrides:

getTimestampQuery in class DatasourcePlatform

initializePlatformOperators

protected void initializePlatformOperators()

INTERNAL: Initialize any platform-specific operators

Overrides:

initializePlatformOperators in class DatasourcePlatform

isDB2

public boolean isDB2()

Specified by:

isDB2 in interface Platform

Overrides:

isDB2 in class DatasourcePlatform

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

shouldIgnoreException

public boolean shouldIgnoreException(java.sql.SQLException exception)

INTERNAL: Allow for the platform to ignore exceptions. This is required for DB2 which throws no-data modified as an exception.

Overrides:

shouldIgnoreException 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

buildSelectQueryForNativeSequence

public ValueReadQuery buildSelectQueryForNativeSequence()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForNativeSequence in class DatabasePlatform

printFieldIdentityClause

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

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

Overrides:

printFieldIdentityClause in class DatabasePlatform

Throws:

ValidationException

shouldNativeSequenceAcquireValueAfterInsert

public boolean shouldNativeSequenceAcquireValueAfterInsert()

INTERNAL: If native sequencing is being used on DB2 then the values must be retrieved after the insert. This method is to be used *ONLY* by sequencing classes

Overrides:

shouldNativeSequenceAcquireValueAfterInsert in class DatabasePlatform

supportsNativeSequenceNumbers

public boolean supportsNativeSequenceNumbers()

Return true if the receiver uses host sequence numbers, generated on the database. DB2 does through AS IDENTITY field types.

Overrides:

supportsNativeSequenceNumbers in class DatabasePlatform

supportsGlobalTempTables

public boolean supportsGlobalTempTables()

INTERNAL:

Overrides:

supportsGlobalTempTables in class DatabasePlatform

getCreateTempTableSqlPrefix

protected java.lang.String getCreateTempTableSqlPrefix()

INTERNAL:

Overrides:

getCreateTempTableSqlPrefix in class DatabasePlatform

getTempTableForTable

public DatabaseTable getTempTableForTable(DatabaseTable table)

INTERNAL:

Overrides:

getTempTableForTable in class DatabasePlatform

Returns:

DatabaseTable temorary table

getCreateTempTableSqlSuffix

protected java.lang.String getCreateTempTableSqlSuffix()

INTERNAL:

Overrides:

getCreateTempTableSqlSuffix in class DatabasePlatform

getCreateTempTableSqlBodyForTable

protected java.lang.String getCreateTempTableSqlBodyForTable(DatabaseTable table)

INTERNAL:

Overrides:

getCreateTempTableSqlBodyForTable in class DatabasePlatform

isNullAllowedInSelectClause

public boolean isNullAllowedInSelectClause()

INTERNAL: Override this if the platform cannot handle NULL in select clause.

Overrides:

isNullAllowedInSelectClause in class DatabasePlatform

writeParameterMarker

public void writeParameterMarker(java.io.Writer writer,
                                 ParameterExpression parameter)
                          throws java.io.IOException

Overrides:

writeParameterMarker in class DatabasePlatform

Throws:

java.io.IOException

shouldBindLiterals

public boolean shouldBindLiterals()

INTERNAL Allows platform to choose whether to bind literals in DatabaseCalls or not.

Overrides:

shouldBindLiterals in class DatabasePlatform