oracle.toplink.essentials.platform.database

Class SybasePlatform

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

All Implemented Interfaces:

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

public class SybasePlatform
extends DatabasePlatform

Purpose: Provides Sybase specific behaviour.

Responsibilities:

• Native SQL for byte[], Date, Time, & Timestamp.
• Native sequencing using @@IDENTITY.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable	typeStrings

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

Method Summary

Modifier and Type	Method and Description
protected void	appendByteArray(byte[] bytes, java.io.Writer writer) INTERNAL: If using native SQL then print a byte[] as '0xFF...'
protected void	appendCalendar(java.util.Calendar calendar, java.io.Writer writer) INTERNAL: Answer a platform correct string representation of a Calendar, suitable for SQL generation.
protected void	appendDate(java.sql.Date date, java.io.Writer writer) INTERNAL: Answer a platform correct string representation of a Date, suitable for SQL generation.
protected void	appendSybaseCalendar(java.util.Calendar calendar, java.io.Writer writer) INTERNAL: Write a timestamp in Sybase specific format ( yyyy-mm-dd-hh.mm.ss.fff)
protected void	appendSybaseTimestamp(java.sql.Timestamp timestamp, java.io.Writer writer) INTERNAL: Write a timestamp in Sybase specific format (yyyy-mm-dd-hh.mm.ss.fff).
protected void	appendTime(java.sql.Time time, java.io.Writer writer) INTERNAL: Answer a platform correct string representation of a Time, suitable for SQL generation.
protected void	appendTimestamp(java.sql.Timestamp timestamp, java.io.Writer writer) INTERNAL: Answer a platform correct string representation of a Timestamp, suitable for SQL generation.
ExpressionOperator	atan2Operator() INTERNAL: Build operator.
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.
java.lang.Object	executeStoredProcedure(DatabaseCall dbCall, java.sql.PreparedStatement statement, DatabaseAccessor accessor, AbstractSession session) INTERNAL: Because each platform has different requirements for accessing stored procedures and the way that we can combine resultsets and output params the stored procedure call is being executed on the platform.
java.lang.String	getBatchDelimiterString() INTERNAL: Used for batch writing and sp defs.
protected java.lang.String	getCreateTempTableSqlPrefix() INTERNAL:
java.lang.String	getCreationInOutputProcedureToken() INTERNAL: This method is used to print the required output parameter token for the specific platform.
java.lang.String	getCreationOutputProcedureToken() INTERNAL: This method was added because SQLServer requires the output paramater token to be set on creation but not on execution.
java.lang.String	getInOutputProcedureToken() INTERNAL: This method is used to print the output parameter token when stored procedures are called
java.lang.String	getJdbcTypeName(int jdbcType) INTERNAL: Returns the type name corresponding to the jdbc type
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.String	getOutputProcedureToken() INTERNAL: This method is used to print the output parameter token when stored procedures are called
java.lang.String	getProcedureArgumentString() INTERNAL: Used for sp defs.
java.lang.String	getProcedureCallHeader() INTERNAL: Used for sp calls.
java.lang.String	getStoredProcedureParameterPrefix() INTERNAL:
java.lang.String	getStoredProcedureTerminationToken() INTERNAL: This method returns the delimiter between stored procedures in multiple stored procedure calls.
DatabaseTable	getTempTableForTable(DatabaseTable table) INTERNAL:
ValueReadQuery	getTimestampQuery() INTERNAL: This method returns the query to select the timestamp from the server for Sybase.
protected java.util.Hashtable	getTypeStrings()
protected void	initializePlatformOperators() INTERNAL: Initialize any platform-specific operators
protected void	initializeTypeStrings()
boolean	isSybase()
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.
ExpressionOperator	modOperator() INTERNAL: Override the default MOD operator.
protected ExpressionOperator	operatorOuterJoin() INTERNAL: Create the outer join operator for this platform
void	printFieldIdentityClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'identity' constraint clause to a writer.
void	printFieldNullClause(java.io.Writer writer) INTERNAL: Append the receiver's field 'NULL' constraint clause to a writer.
void	registerOutputParameter(java.sql.CallableStatement statement, int index, int jdbcType) INTERNAL: This method is used to register output parameter on Callable Statements for Stored Procedures as each database seems to have a different method.
boolean	requiresProcedureCallBrackets() INTERNAL: USed for sp calls.
boolean	requiresProcedureCallOuputToken() INTERNAL: Used for sp calls.
boolean	requiresTypeNameToRegisterOutputParameter() INTERNAL: Indicates whether the version of CallableStatement.registerOutputParameter method that takes type name should be used.
boolean	shouldNativeSequenceAcquireValueAfterInsert() INTERNAL: If native sequencing is being used on Sybase then the values must be retrieved after the insert.
boolean	shouldPrintInOutputTokenBeforeType() INTERNAL: This is required in the construction of the stored procedures with output parameters
boolean	shouldPrintOuterJoinInWhereClause() INTERNAL: Some database require outer joins to be given in the where clause, others require it in the from clause.
boolean	shouldPrintOutputTokenBeforeType() 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	supportsLocalTempTables() INTERNAL:
boolean	supportsNativeSequenceNumbers() INTERNAL: Return true if the receiver uses host sequence numbers, generated on the database.
void	writeUpdateOriginalFromTempTableSql(java.io.Writer writer, DatabaseTable table, java.util.Collection pkFields, java.util.Collection assignedFields) INTERNAL:

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, getAssignmentString, getBatchBeginString, getBatchEndString, getClassTypes, getConstraintDeletionString, getCreateTempTableSqlBodyForTable, getCreateTempTableSqlSuffix, getCreateViewString, getCursorCode, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getJDBCOuterJoinString, getJDBCType, getJDBCType, getMaxForeignKeyNameSize, getMaxUniqueKeyNameSize, getObjectFromResultSet, getProcedureArgumentSetter, getProcedureAsString, getProcedureBeginString, getProcedureCallTail, getProcedureEndString, getQualifiedSequenceTableName, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStringBindingSize, getTransactionIsolation, isInformixOuterJoin, isNullAllowedInSelectClause, printFieldIdentityClause, printFieldNotNullClause, printFieldTypeSize, printFieldUnique, printValuelist, printValuelist, processResultSet, requiresNamedPrimaryKeyConstraints, 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, shouldBindLiterals, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldNativeSequenceUseTransaction, shouldOptimizeDataConversion, shouldPrintConstraintNameAfter, shouldPrintOutputTokenAtStart, shouldTempTableSpecifyPrimaryKeys, shouldTrimStrings, supportsAutoCommit, supportsForeignKeyConstraints, supportsGlobalTempTables, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueKeyConstraints, usesByteArrayBinding, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, writeAutoAssignmentSetClause, writeAutoJoinWhereClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeFields, writeFieldsAutoClause, writeFieldsList, writeInsertIntoTableSql, writeJoinWhereClause, writeLOB, writeParameterMarker

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, isOracle, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, 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

Field Detail

typeStrings

protected java.util.Hashtable typeStrings

Constructor Detail

SybasePlatform

public SybasePlatform()

Method Detail

getTypeStrings

protected java.util.Hashtable getTypeStrings()

initializeTypeStrings

protected void initializeTypeStrings()

appendByteArray

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

INTERNAL: If using native SQL then print a byte[] as '0xFF...'

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: Answer a platform correct string representation of a Date, suitable for SQL generation. Native format: 'yyyy-mm-dd

Overrides:

appendDate in class DatabasePlatform

Throws:

java.io.IOException

appendSybaseTimestamp

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

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

Throws:

java.io.IOException

appendTime

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

INTERNAL: Answer a platform correct string representation of a Time, suitable for SQL generation. The time is printed in the ODBC platform independent format {t'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: Answer a platform correct string representation of a Timestamp, suitable for SQL generation. The date is printed in the ODBC platform independent format {d'YYYY-MM-DD'}.

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: Answer a platform correct string representation of a Calendar, suitable for SQL generation. The date is printed in the ODBC platform independent format {d'YYYY-MM-DD'}.

Overrides:

appendCalendar in class DatabasePlatform

Throws:

java.io.IOException

appendSybaseCalendar

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

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

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

buildSelectQueryForNativeSequence

public ValueReadQuery buildSelectQueryForNativeSequence()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForNativeSequence in class DatabasePlatform

executeStoredProcedure

public java.lang.Object executeStoredProcedure(DatabaseCall dbCall,
                                               java.sql.PreparedStatement statement,
                                               DatabaseAccessor accessor,
                                               AbstractSession session)
                                        throws java.sql.SQLException

INTERNAL: Because each platform has different requirements for accessing stored procedures and the way that we can combine resultsets and output params the stored procedure call is being executed on the platform. This entire process needs some serious refactoring to eliminate the chance of bugs.

Overrides:

executeStoredProcedure in class DatabasePlatform

Throws:

java.sql.SQLException

getBatchDelimiterString

public java.lang.String getBatchDelimiterString()

INTERNAL: Used for batch writing and sp defs.

Overrides:

getBatchDelimiterString in class DatabasePlatform

getCreationInOutputProcedureToken

public java.lang.String getCreationInOutputProcedureToken()

INTERNAL: This method is used to print the required output parameter token for the specific platform. Used when stored procedures are created.

Overrides:

getCreationInOutputProcedureToken in class DatabasePlatform

getCreationOutputProcedureToken

public java.lang.String getCreationOutputProcedureToken()

INTERNAL: This method was added because SQLServer requires the output paramater token to be set on creation but not on execution.

Overrides:

getCreationOutputProcedureToken in class DatabasePlatform

getInOutputProcedureToken

public java.lang.String getInOutputProcedureToken()

INTERNAL: This method is used to print the output parameter token when stored procedures are called

Overrides:

getInOutputProcedureToken in class DatabasePlatform

getJdbcTypeName

public java.lang.String getJdbcTypeName(int jdbcType)

INTERNAL: Returns the type name corresponding to the jdbc type

Overrides:

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

getOutputProcedureToken

public java.lang.String getOutputProcedureToken()

INTERNAL: This method is used to print the output parameter token when stored procedures are called

Overrides:

getOutputProcedureToken in class DatabasePlatform

getProcedureArgumentString

public java.lang.String getProcedureArgumentString()

INTERNAL: Used for sp defs.

Overrides:

getProcedureArgumentString in class DatabasePlatform

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()

INTERNAL: Used for sp calls.

Overrides:

getProcedureCallHeader in class DatabasePlatform

getStoredProcedureParameterPrefix

public java.lang.String getStoredProcedureParameterPrefix()

INTERNAL:

Overrides:

getStoredProcedureParameterPrefix in class DatabasePlatform

getStoredProcedureTerminationToken

public java.lang.String getStoredProcedureTerminationToken()

INTERNAL: This method returns the delimiter between stored procedures in multiple stored procedure calls.

Overrides:

getStoredProcedureTerminationToken in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

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

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

isSybase

public boolean isSybase()

Specified by:

isSybase in interface Platform

Overrides:

isSybase 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

modOperator

public ExpressionOperator modOperator()

INTERNAL: Override the default MOD operator.

operatorOuterJoin

protected ExpressionOperator operatorOuterJoin()

INTERNAL: Create the outer join operator for this platform

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

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

registerOutputParameter

public void registerOutputParameter(java.sql.CallableStatement statement,
                                    int index,
                                    int jdbcType)
                             throws java.sql.SQLException

INTERNAL: This method is used to register output parameter on Callable Statements for Stored Procedures as each database seems to have a different method.

Overrides:

registerOutputParameter in class DatabasePlatform

Throws:

java.sql.SQLException

requiresProcedureCallBrackets

public boolean requiresProcedureCallBrackets()

INTERNAL: USed for sp calls.

Overrides:

requiresProcedureCallBrackets in class DatabasePlatform

requiresProcedureCallOuputToken

public boolean requiresProcedureCallOuputToken()

INTERNAL: Used for sp calls. Sybase must print output after output params.

Overrides:

requiresProcedureCallOuputToken in class DatabasePlatform

requiresTypeNameToRegisterOutputParameter

public boolean requiresTypeNameToRegisterOutputParameter()

INTERNAL: Indicates whether the version of CallableStatement.registerOutputParameter method that takes type name should be used.

Overrides:

requiresTypeNameToRegisterOutputParameter in class DatabasePlatform

shouldPrintInOutputTokenBeforeType

public boolean shouldPrintInOutputTokenBeforeType()

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

Overrides:

shouldPrintInOutputTokenBeforeType in class DatabasePlatform

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

shouldPrintOutputTokenBeforeType

public boolean shouldPrintOutputTokenBeforeType()

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

Overrides:

shouldPrintOutputTokenBeforeType in class DatabasePlatform

shouldNativeSequenceAcquireValueAfterInsert

public boolean shouldNativeSequenceAcquireValueAfterInsert()

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

Overrides:

shouldNativeSequenceAcquireValueAfterInsert 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. Sybase does through IDENTITY field types.

Overrides:

supportsNativeSequenceNumbers in class DatabasePlatform

supportsLocalTempTables

public boolean supportsLocalTempTables()

INTERNAL:

Overrides:

supportsLocalTempTables 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

writeUpdateOriginalFromTempTableSql

public void writeUpdateOriginalFromTempTableSql(java.io.Writer writer,
                                                DatabaseTable table,
                                                java.util.Collection pkFields,
                                                java.util.Collection assignedFields)
                                         throws java.io.IOException

INTERNAL:

Overrides:

writeUpdateOriginalFromTempTableSql in class DatabasePlatform

Throws:

java.io.IOException