Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.internal.databaseaccess
Class OraclePlatform

java.lang.Object
  extended byoracle.toplink.internal.databaseaccess.DatabasePlatform
      extended byoracle.toplink.internal.databaseaccess.OraclePlatform

All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
Oracle8Platform

public class OraclePlatform
extends DatabasePlatform

Purpose: Provides Oracle specific behaviour.

Responsibilities:

Since:
TOPLink/Java 1.0
See Also:
Serialized Form

Field Summary

Fields inherited from class oracle.toplink.internal.databaseaccess.DatabasePlatform
DEFAULT_MAX_BATCH_WRITING_SIZE, DEFAULT_PARAMETERIZED_MAX_BATCH_WRITING_SIZE

Constructor Summary
OraclePlatform()

Method Summary
boolean allowsSizeInProcedureArguments()
Used for sp defs.
java.lang.String getBatchBeginString()
Used for batch writing and sp defs.
java.lang.String getBatchEndString()
Used for batch writing and sp defs.
java.util.Vector getNativeTableInfo(java.lang.String table, java.lang.String creator, oracle.toplink.publicinterface.Session session)
Return the catalog information through using the native SQL catalog selects.
java.lang.String getProcedureArgumentSetter()
Used for sp calls.
java.lang.String getProcedureCallHeader()
Used for sp calls.
java.lang.String getProcedureCallTail()
Used for sp calls.
java.lang.String getSelectForUpdateString()
Most database support a syntax. although don't actually lock the row.
java.lang.String getStoredProcedureParameterPrefix()
java.lang.String getStoredProcedureTerminationToken()
ValueReadQuery getTimestampQuery()
PUBLIC: This method returns the query to select the timestamp from the server for Oracle.
boolean isOracle()
java.util.Hashtable maximumNumericValues()
Builds a table of maximum numeric values keyed on java class.
java.util.Hashtable minimumNumericValues()
Builds a table of minimum numeric values keyed on java class.
void printFieldNullClause(java.io.Writer writer)
Append the receiver's field 'NULL' constraint clause to a writer.
java.lang.String serverTimestampString()
Return the current date and time from the server.
boolean shouldPrintOuterJoinInWhereClause()
Some database require outer joins to be given in the where clause, others require it in the from clause.
boolean shouldUseJDBCOuterJoinSyntax()
JDBC defines and outer join syntax, many drivers do not support this.
boolean supportsNativeSequenceNumbers()
Return true if the receiver uses host sequence numbers, generated on the database.
boolean supportsSelectForUpdateNoWait()
Returns true if the database supports SQL syntax not to wait on a SELECT..FOR UPADTE (i.e.

Methods inherited from class oracle.toplink.internal.databaseaccess.DatabasePlatform
appendParameter, autoCommit, beginTransaction, buildProcedureCallString, clone, commitTransaction, convertObject, copyInto, executeStoredProcedureCall, getBatchDelimiterString, getClassTypes, getConversionManager, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getFieldTypeDefinition, getFieldTypes, getInOutputProcedureToken, getJDBCType, getJDBCType, getMaxBatchWritingSize, getOperator, getOutputProcedureToken, getPlatformOperators, getProcedureArgumentString, getQualifiedSequenceTableName, getSelectForUpdateNoWaitString, getSelectSequenceQuery, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStringBindingSize, getTableQualifier, getTimestampFromServer, getTransactionIsolation, getUpdateSequenceQuery, initializePreallocatedSequences, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isHSQL, isInformix, isInformixOuterJoin, isODBC, isPointBase, isSQLAnywhere, isSQLServer, isSybase, printFieldIdentityClause, printFieldNotNullClause, printValuelist, printValuelist, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, rollbackTransaction, setConversionManager, setCursorCode, setMaxBatchWritingSize, setSelectSequenceNumberQuery, setSequenceCounterFieldName, setSequenceNameFieldName, setSequencePreallocationSize, setSequenceTableName, setShouldBindAllParameters, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTableQualifier, setTimestampQuery, setTransactionIsolation, setUpdateSequenceQuery, setUsesBatchWriting, setUsesByteArrayBinding, setUsesJDBCBatchWriting, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldBindAllParameters, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldOptimizeDataConversion, shouldPrintConstraintNameAfter, shouldPrintInOutputTokenBeforeType, shouldPrintOutputTokenBeforeType, shouldTrimStrings, supportsAutoCommit, supportsForeignKeyConstraints, supportsPrimaryKeyConstraint, toString, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeSequencing, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OraclePlatform

public OraclePlatform()

Method Detail

allowsSizeInProcedureArguments

public boolean allowsSizeInProcedureArguments()
Used for sp defs.
Overrides:
allowsSizeInProcedureArguments in class DatabasePlatform

getBatchBeginString

public java.lang.String getBatchBeginString()
Used for batch writing and sp defs.
Overrides:
getBatchBeginString in class DatabasePlatform

getBatchEndString

public java.lang.String getBatchEndString()
Used for batch writing and sp defs.
Overrides:
getBatchEndString in class DatabasePlatform

getNativeTableInfo

public java.util.Vector getNativeTableInfo(java.lang.String table,
                                           java.lang.String creator,
                                           oracle.toplink.publicinterface.Session session)
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()
Used for sp calls.
Overrides:
getProcedureArgumentSetter in class DatabasePlatform

getProcedureCallHeader

public java.lang.String getProcedureCallHeader()
Used for sp calls.
Overrides:
getProcedureCallHeader in class DatabasePlatform

getProcedureCallTail

public java.lang.String getProcedureCallTail()
Used for sp calls.
Overrides:
getProcedureCallTail in class DatabasePlatform

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()
Description copied from class: DatabasePlatform
Most database support a syntax. although don't actually lock the row. Some require the OF some don't like it.
Overrides:
getSelectForUpdateString in class DatabasePlatform

getStoredProcedureParameterPrefix

public java.lang.String getStoredProcedureParameterPrefix()
Overrides:
getStoredProcedureParameterPrefix in class DatabasePlatform

getStoredProcedureTerminationToken

public java.lang.String getStoredProcedureTerminationToken()
Overrides:
getStoredProcedureTerminationToken in class DatabasePlatform

getTimestampQuery

public ValueReadQuery getTimestampQuery()
PUBLIC: This method returns the query to select the timestamp from the server for Oracle.
Overrides:
getTimestampQuery in class DatabasePlatform

isOracle

public boolean isOracle()
Overrides:
isOracle in class DatabasePlatform

maximumNumericValues

public java.util.Hashtable maximumNumericValues()
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()
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

printFieldNullClause

public void printFieldNullClause(java.io.Writer writer)
                          throws ValidationException
Append the receiver's field 'NULL' constraint clause to a writer.
Overrides:
printFieldNullClause in class DatabasePlatform
Throws:
ValidationException

serverTimestampString

public java.lang.String serverTimestampString()
Return the current date and time from the server.

shouldPrintOuterJoinInWhereClause

public boolean shouldPrintOuterJoinInWhereClause()
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()
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()
Return true if the receiver uses host sequence numbers, generated on the database. Oracle does through global sequence objects.
Overrides:
supportsNativeSequenceNumbers in class DatabasePlatform

supportsSelectForUpdateNoWait

public boolean supportsSelectForUpdateNoWait()
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)

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.