org.hibernate.dialect
Class Oracle8iDialect

java.lang.Object
  org.hibernate.dialect.Dialect
      org.hibernate.dialect.Oracle8iDialect

Direct Known Subclasses:

Oracle9iDialect

public class Oracle8iDialect
extends Dialect

A dialect for Oracle 8i.

Author:

Steve Ebersole

Field Summary

static String	DEPRECATED_ORACLE_TYPES_CLASS_NAME
static int	INIT_ORACLETYPES_CURSOR_VALUE
static String	ORACLE_TYPES_CLASS_NAME

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, DEFAULT_BATCH_SIZE, NO_BATCH, QUOTE

Constructor Summary

Oracle8iDialect()

Method Summary

boolean	bindLimitParametersInReverseOrder() ANSI SQL defines the LIMIT clause to be in the form LIMIT offset, limit.
CaseFragment	createCaseFragment() Map case support to the Oracle DECODE function.
JoinFragment	createOuterJoinFragment() Support for the oracle proprietary join syntax...
boolean	dropConstraints() Do we need to drop constraints before dropping tables in this dialect?
boolean	dropTemporaryTableAfterUse() Do we need to drop the temporary table after use?
protected int	extractOracleCursorTypeValue()
boolean	forUpdateOfColumns() Is FOR UPDATE OF syntax supported?
String	generateTemporaryTableName(String baseTableName) Generate a temporary table name given the bas table.
String	getAddColumnString() The syntax used to add a column to a table (optional).
String	getBasicSelectClauseNullString(int sqlType) Allows access to the basic Dialect.getSelectClauseNullString(int) implementation...
String	getCascadeConstraintsString() Completely optional cascading drop clause
String	getCreateSequenceString(String sequenceName) Typically dialects which support sequences can create a sequence with a single command.
String	getCreateTemporaryTablePostfix() Get any fragments needing to be postfixed to the command for temporary table creation.
String	getCreateTemporaryTableString() Command used to create a temporary table.
String	getCrossJoinSeparator() Get the separator to use for defining cross joins when translating HQL queries.
String	getCurrentTimestampSelectString() Retrieve the command used to retrieve the current timestamp from the database.
String	getCurrentTimestampSQLFunctionName() The name of the database-specific SQL function for retrieving the current timestamp.
String	getDropSequenceString(String sequenceName) Typically dialects which support sequences can drop a sequence with a single command.
String	getForUpdateNowaitString() Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.
String	getForUpdateNowaitString(String aliases) Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect given the aliases of the columns to be write locked.
String	getForUpdateString(String aliases) Get the FOR UPDATE OF column_list fragment appropriate for this dialect given the aliases of the columns to be write locked.
String	getLimitString(String sql, boolean hasOffset) Apply s limit clause to the query.
int	getOracleCursorTypeSqlType()
String	getQuerySequencesString() Get the select command used retrieve the names of all sequences.
ResultSet	getResultSet(CallableStatement ps) Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.
String	getSelectClauseNullString(int sqlType) Given a Types type code, determine an appropriate null value to use in a select clause.
String	getSelectGUIDString() Get the command used to select a GUID from the underlying database.
String	getSelectSequenceNextValString(String sequenceName) Generate the select expression fragment that will retrieve the next value of a sequence as part of another (typically DML) statement.
String	getSequenceNextValString(String sequenceName) Generate the appropriate select statement to to retrieve the next value of a sequence.
ViolatedConstraintNameExtracter	getViolatedConstraintNameExtracter()
boolean	isCurrentTimestampSelectStringCallable() Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable.
protected void	registerCharacterTypeMappings()
protected void	registerDateTimeTypeMappings()
protected void	registerDefaultProperties()
protected void	registerFunctions()
protected void	registerLargeObjectTypeMappings()
protected void	registerNumericTypeMappings()
int	registerResultSetOutParameter(CallableStatement statement, int col) Registers an OUT parameter which will be returning a ResultSet.
protected void	registerReverseHibernateTypeMappings()
boolean	supportsCommentOn()
boolean	supportsCurrentTimestampSelection() Does this dialect support a way to retrieve the database's current timestamp value?
boolean	supportsEmptyInList() Does this dialect support empty IN lists? For example, is [where XYZ in ()] a supported construct?
boolean	supportsExistsInSelect() Does the dialect support an exists statement in the select clause?
boolean	supportsLimit() Does this dialect support some form of limiting query results via a SQL clause?
boolean	supportsPooledSequences() Does this dialect support "pooled" sequences.
boolean	supportsSequences() Does this dialect support sequences?
boolean	supportsTemporaryTables() Does this dialect support temporary tables?
boolean	supportsUnionAll() Does this dialect support UNION ALL, which is generally a faster variant of UNION?
boolean	useMaxForLimit() Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows? This is easiest understood via an example.

Methods inherited from class org.hibernate.dialect.Dialect

appendIdentitySelectToInsert, appendLockHint, applyLocksToSql, areStringComparisonsCaseInsensitive, bindLimitParametersFirst, buildSQLExceptionConverter, closeQuote, convertToFirstRowValue, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, forceLimitUsage, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getCastTypeName, getColumnComment, getCreateMultisetTableString, getCreateSequenceString, getCreateSequenceStrings, getCreateSequenceStrings, getCreateTableString, getDefaultProperties, getDialect, getDialect, getDropForeignKeyString, getDropSequenceStrings, getDropTemporaryTableString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctions, getHibernateTypeName, getHibernateTypeName, getIdentityColumnString, getIdentityColumnString, getIdentityInsertString, getIdentitySelectString, getIdentitySelectString, getKeywords, getLimitString, getLockingStrategy, getLowercaseFunction, getMaxAliasLength, getNativeIdentifierGeneratorClass, getNoColumnsInsertString, getNullColumnString, getReadLockString, getTableComment, getTableTypeString, getTypeName, getTypeName, getWriteLockString, hasAlterTable, hasDataTypeInIdentityColumn, hasSelfReferentialForeignKeyBug, isLockTimeoutParameterized, openQuote, performTemporaryTableDDLInIsolation, qualifyIndexName, quote, registerColumnType, registerColumnType, registerFunction, registerHibernateType, registerHibernateType, registerKeyword, requiresCastingOfParametersInSelectClause, supportsBindAsCallableArgument, supportsCascadeDelete, supportsCircularCascadeDeleteConstraints, supportsColumnCheck, supportsExpectedLobUsagePattern, supportsIdentityColumns, supportsIfExistsAfterTableName, supportsIfExistsBeforeTableName, supportsInsertSelectIdentity, supportsLimitOffset, supportsLobValueChangePropogation, supportsLockTimeouts, supportsNotNullUnique, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInList, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTupleCounts, supportsTupleDistinctCounts, supportsUnboundedLobLocatorMaterialization, supportsUnique, supportsUniqueConstraintInCreateAlterTable, supportsVariableLimit, toBooleanValueString, toString, transformSelectString, useInputStreamToInsertBlob

Methods inherited from class java.lang.Object

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

Field Detail

ORACLE_TYPES_CLASS_NAME

public static final String ORACLE_TYPES_CLASS_NAME

See Also:

Constant Field Values

DEPRECATED_ORACLE_TYPES_CLASS_NAME

public static final String DEPRECATED_ORACLE_TYPES_CLASS_NAME

See Also:

Constant Field Values

INIT_ORACLETYPES_CURSOR_VALUE

public static final int INIT_ORACLETYPES_CURSOR_VALUE

See Also:

Constant Field Values

Constructor Detail

Oracle8iDialect

public Oracle8iDialect()

Method Detail

registerCharacterTypeMappings

protected void registerCharacterTypeMappings()

registerNumericTypeMappings

protected void registerNumericTypeMappings()

registerDateTimeTypeMappings

protected void registerDateTimeTypeMappings()

registerLargeObjectTypeMappings

protected void registerLargeObjectTypeMappings()

registerReverseHibernateTypeMappings

protected void registerReverseHibernateTypeMappings()

registerFunctions

protected void registerFunctions()

registerDefaultProperties

protected void registerDefaultProperties()

createOuterJoinFragment

public JoinFragment createOuterJoinFragment()

Support for the oracle proprietary join syntax...

Overrides:

createOuterJoinFragment in class Dialect

Returns:

The orqacle join fragment

getCrossJoinSeparator

public String getCrossJoinSeparator()

Get the separator to use for defining cross joins when translating HQL queries.

Typically this will be either [ cross join ] or [, ]

Note that the spaces are important!

Overrides:

getCrossJoinSeparator in class Dialect

Returns:

createCaseFragment

public CaseFragment createCaseFragment()

Map case support to the Oracle DECODE function. Oracle did not add support for CASE until 9i.

Overrides:

createCaseFragment in class Dialect

Returns:

The oracle CASE -> DECODE fragment

getLimitString

public String getLimitString(String sql,
                             boolean hasOffset)

Description copied from class: Dialect

Apply s limit clause to the query.

Typically dialects utilize variable limit clauses when they support limits. Thus, when building the select command we do not actually need to know the limit or the offest since we will just be using placeholders.

Here we do still pass along whether or not an offset was specified so that dialects not supporting offsets can generate proper exceptions. In general, dialects will override one or the other of this method and Dialect.getLimitString(String, int, int).

Overrides:

getLimitString in class Dialect

Parameters:

sql - The query to which to apply the limit.

hasOffset - Is the query requesting an offset?

Returns:

the modified SQL

getBasicSelectClauseNullString

public String getBasicSelectClauseNullString(int sqlType)

Allows access to the basic Dialect.getSelectClauseNullString(int) implementation...

Parameters:

sqlType - The Types mapping type code

Returns:

The appropriate select cluse fragment

getSelectClauseNullString

public String getSelectClauseNullString(int sqlType)

Description copied from class: Dialect

Given a Types type code, determine an appropriate null value to use in a select clause.

One thing to consider here is that certain databases might require proper casting for the nulls here since the select here will be part of a UNION/UNION ALL.

Overrides:

getSelectClauseNullString in class Dialect

Parameters:

sqlType - The Types type code.

Returns:

The appropriate select clause value fragment.

getCurrentTimestampSelectString

public String getCurrentTimestampSelectString()

Description copied from class: Dialect

Retrieve the command used to retrieve the current timestamp from the database.

Overrides:

getCurrentTimestampSelectString in class Dialect

Returns:

The command.

getCurrentTimestampSQLFunctionName

public String getCurrentTimestampSQLFunctionName()

Description copied from class: Dialect

The name of the database-specific SQL function for retrieving the current timestamp.

Overrides:

getCurrentTimestampSQLFunctionName in class Dialect

Returns:

The function name.

getAddColumnString

public String getAddColumnString()

Description copied from class: Dialect

The syntax used to add a column to a table (optional).

Overrides:

getAddColumnString in class Dialect

Returns:

The "add column" fragment.

getSequenceNextValString

public String getSequenceNextValString(String sequenceName)

Description copied from class: Dialect

Generate the appropriate select statement to to retrieve the next value of a sequence.

This should be a "stand alone" select statement.

Overrides:

getSequenceNextValString in class Dialect

Parameters:

sequenceName - the name of the sequence

Returns:

String The "nextval" select string.

getSelectSequenceNextValString

public String getSelectSequenceNextValString(String sequenceName)

Description copied from class: Dialect

Generate the select expression fragment that will retrieve the next value of a sequence as part of another (typically DML) statement.

This differs from Dialect.getSequenceNextValString(String) in that this should return an expression usable within another statement.

Overrides:

getSelectSequenceNextValString in class Dialect

Parameters:

sequenceName - the name of the sequence

Returns:

The "nextval" fragment.

getCreateSequenceString

public String getCreateSequenceString(String sequenceName)

Description copied from class: Dialect

Typically dialects which support sequences can create a sequence with a single command. This is convenience form of Dialect.getCreateSequenceStrings(java.lang.String) to help facilitate that.

Dialects which support sequences and can create a sequence in a single command need *only* override this method. Dialects which support sequences but require multiple commands to create a sequence should instead override Dialect.getCreateSequenceStrings(java.lang.String).

Overrides:

getCreateSequenceString in class Dialect

Parameters:

sequenceName - The name of the sequence

Returns:

The sequence creation command

getDropSequenceString

public String getDropSequenceString(String sequenceName)

Description copied from class: Dialect

Typically dialects which support sequences can drop a sequence with a single command. This is convenience form of Dialect.getDropSequenceStrings(java.lang.String) to help facilitate that.

Dialects which support sequences and can drop a sequence in a single command need *only* override this method. Dialects which support sequences but require multiple commands to drop a sequence should instead override Dialect.getDropSequenceStrings(java.lang.String).

Overrides:

getDropSequenceString in class Dialect

Parameters:

sequenceName - The name of the sequence

Returns:

The sequence drop commands

getCascadeConstraintsString

public String getCascadeConstraintsString()

Description copied from class: Dialect

Completely optional cascading drop clause

Overrides:

getCascadeConstraintsString in class Dialect

Returns:

String

dropConstraints

public boolean dropConstraints()

Description copied from class: Dialect

Do we need to drop constraints before dropping tables in this dialect?

Overrides:

dropConstraints in class Dialect

Returns:

True if constraints must be dropped prior to dropping the table; false otherwise.

getForUpdateNowaitString

public String getForUpdateNowaitString()

Description copied from class: Dialect

Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect.

Overrides:

getForUpdateNowaitString in class Dialect

Returns:

The appropriate FOR UPDATE NOWAIT clause string.

supportsSequences

public boolean supportsSequences()

Description copied from class: Dialect

Does this dialect support sequences?

Overrides:

supportsSequences in class Dialect

Returns:

True if sequences supported; false otherwise.

supportsPooledSequences

public boolean supportsPooledSequences()

Description copied from class: Dialect

Does this dialect support "pooled" sequences. Not aware of a better name for this. Essentially can we specify the initial and increment values?

Overrides:

supportsPooledSequences in class Dialect

Returns:

True if such "pooled" sequences are supported; false otherwise.

See Also:

Dialect.getCreateSequenceStrings(String, int, int), Dialect.getCreateSequenceString(String, int, int)

supportsLimit

public boolean supportsLimit()

Description copied from class: Dialect

Does this dialect support some form of limiting query results via a SQL clause?

Overrides:

supportsLimit in class Dialect

Returns:

True if this dialect supports some form of LIMIT.

getForUpdateString

public String getForUpdateString(String aliases)

Description copied from class: Dialect

Get the FOR UPDATE OF column_list fragment appropriate for this dialect given the aliases of the columns to be write locked.

Overrides:

getForUpdateString in class Dialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE OF column_list clause string.

getForUpdateNowaitString

public String getForUpdateNowaitString(String aliases)

Description copied from class: Dialect

Get the FOR UPDATE OF column_list NOWAIT fragment appropriate for this dialect given the aliases of the columns to be write locked.

Overrides:

getForUpdateNowaitString in class Dialect

Parameters:

aliases - The columns to be write locked.

Returns:

The appropriate FOR UPDATE colunm_list NOWAIT clause string.

bindLimitParametersInReverseOrder

public boolean bindLimitParametersInReverseOrder()

Description copied from class: Dialect

ANSI SQL defines the LIMIT clause to be in the form LIMIT offset, limit. Does this dialect require us to bind the parameters in reverse order?

Overrides:

bindLimitParametersInReverseOrder in class Dialect

Returns:

true if the correct order is limit, offset

useMaxForLimit

public boolean useMaxForLimit()

Description copied from class: Dialect

Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows?

This is easiest understood via an example. Consider you have a table with 20 rows, but you only want to retrieve rows number 11 through 20. Generally, a limit with offset would say that the offset = 11 and the limit = 10 (we only want 10 rows at a time); this is specifying the total number of returned rows. Some dialects require that we instead specify offset = 11 and limit = 20, where 20 is the "last" row we want relative to offset (i.e. total number of rows = 20 - 11 = 9)

So essentially, is limit relative from offset? Or is limit absolute?

Overrides:

useMaxForLimit in class Dialect

Returns:

True if limit is relative from offset; false otherwise.

forUpdateOfColumns

public boolean forUpdateOfColumns()

Description copied from class: Dialect

Is FOR UPDATE OF syntax supported?

Overrides:

forUpdateOfColumns in class Dialect

Returns:

True if the database supports FOR UPDATE OF syntax; false otherwise.

getQuerySequencesString

public String getQuerySequencesString()

Description copied from class: Dialect

Get the select command used retrieve the names of all sequences.

Overrides:

getQuerySequencesString in class Dialect

Returns:

The select command; or null if sequences are not supported.

See Also:

SchemaUpdate

getSelectGUIDString

public String getSelectGUIDString()

Description copied from class: Dialect

Get the command used to select a GUID from the underlying database.

Optional operation.

Overrides:

getSelectGUIDString in class Dialect

Returns:

The appropriate command.

getViolatedConstraintNameExtracter

public ViolatedConstraintNameExtracter getViolatedConstraintNameExtracter()

Overrides:

getViolatedConstraintNameExtracter in class Dialect

getOracleCursorTypeSqlType

public int getOracleCursorTypeSqlType()

extractOracleCursorTypeValue

protected int extractOracleCursorTypeValue()

registerResultSetOutParameter

public int registerResultSetOutParameter(CallableStatement statement,
                                         int col)
                                  throws SQLException

Description copied from class: Dialect

Registers an OUT parameter which will be returning a ResultSet. How this is accomplished varies greatly from DB to DB, hence its inclusion (along with Dialect.getResultSet(java.sql.CallableStatement)) here.

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

col - The bind position at which to register the OUT param.

Returns:

The number of (contiguous) bind positions used.

Throws:

SQLException - Indicates problems registering the OUT param.

getResultSet

public ResultSet getResultSet(CallableStatement ps)
                       throws SQLException

Description copied from class: Dialect

Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.

Overrides:

getResultSet in class Dialect

Parameters:

ps - The callable statement.

Returns:

The extracted result set.

Throws:

SQLException - Indicates problems extracting the result set.

supportsUnionAll

public boolean supportsUnionAll()

Description copied from class: Dialect

Does this dialect support UNION ALL, which is generally a faster variant of UNION?

Overrides:

supportsUnionAll in class Dialect

Returns:

True if UNION ALL is supported; false otherwise.

supportsCommentOn

public boolean supportsCommentOn()

Overrides:

supportsCommentOn in class Dialect

supportsTemporaryTables

public boolean supportsTemporaryTables()

Description copied from class: Dialect

Does this dialect support temporary tables?

Overrides:

supportsTemporaryTables in class Dialect

Returns:

True if temp tables are supported; false otherwise.

generateTemporaryTableName

public String generateTemporaryTableName(String baseTableName)

Description copied from class: Dialect

Generate a temporary table name given the bas table.

Overrides:

generateTemporaryTableName in class Dialect

Parameters:

baseTableName - The table name from which to base the temp table name.

Returns:

The generated temp table name.

getCreateTemporaryTableString

public String getCreateTemporaryTableString()

Description copied from class: Dialect

Command used to create a temporary table.

Overrides:

getCreateTemporaryTableString in class Dialect

Returns:

The command used to create a temporary table.

getCreateTemporaryTablePostfix

public String getCreateTemporaryTablePostfix()

Description copied from class: Dialect

Get any fragments needing to be postfixed to the command for temporary table creation.

Overrides:

getCreateTemporaryTablePostfix in class Dialect

Returns:

Any required postfix.

dropTemporaryTableAfterUse

public boolean dropTemporaryTableAfterUse()

Description copied from class: Dialect

Do we need to drop the temporary table after use?

Overrides:

dropTemporaryTableAfterUse in class Dialect

Returns:

True if the table should be dropped.

supportsCurrentTimestampSelection

public boolean supportsCurrentTimestampSelection()

Description copied from class: Dialect

Does this dialect support a way to retrieve the database's current timestamp value?

Overrides:

supportsCurrentTimestampSelection in class Dialect

Returns:

True if the current timestamp can be retrieved; false otherwise.

isCurrentTimestampSelectStringCallable

public boolean isCurrentTimestampSelectStringCallable()

Description copied from class: Dialect

Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable. Typically this indicates that JDBC escape syntax is being used...

Overrides:

isCurrentTimestampSelectStringCallable in class Dialect

Returns:

True if the Dialect.getCurrentTimestampSelectString() return is callable; false otherwise.

supportsEmptyInList

public boolean supportsEmptyInList()

Description copied from class: Dialect

Does this dialect support empty IN lists?

For example, is [where XYZ in ()] a supported construct?

Overrides:

supportsEmptyInList in class Dialect

Returns:

True if empty in lists are supported; false otherwise.

supportsExistsInSelect

public boolean supportsExistsInSelect()

Description copied from class: Dialect

Does the dialect support an exists statement in the select clause?

Overrides:

supportsExistsInSelect in class Dialect

Returns:

True if exists checks are allowed in the select clause; false otherwise.