org.eclipse.persistence.platform.database
Class HSQLPlatform

java.lang.Object
  org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform
      org.eclipse.persistence.internal.databaseaccess.DatabasePlatform
          org.eclipse.persistence.platform.database.DatabasePlatform
              org.eclipse.persistence.platform.database.HSQLPlatform

All Implemented Interfaces:

Serializable, Cloneable, org.eclipse.persistence.internal.databaseaccess.Platform

public class HSQLPlatform
extends DatabasePlatform

Purpose: Provides HSQL specific behavior. Support HSQL functionality as of 1.8.1.

Includes:

• DDL creation
• IDENTITY sequencing
• SEQUENCE objects
• Functions
• Pagination

  Since:

  TOPLink/Java 4.5

  See Also:

  Serialized Form

  Field Summary

  Fields inherited from class org.eclipse.persistence.platform.database.DatabasePlatform

  DEFAULT_VARCHAR_SIZE

  Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  DEFAULT_MAX_BATCH_WRITING_SIZE, DEFAULT_PARAMETERIZED_MAX_BATCH_WRITING_SIZE, Types_NCLOB

  Constructor Summary

  HSQLPlatform()
  

  Method Summary

  ValueReadQuery	buildSelectQueryForIdentity() INTERNAL: Returns query used to read back the value generated by Identity.
  ValueReadQuery	buildSelectQueryForSequenceObject(String seqName, Integer size) INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence).
  Writer	buildSequenceObjectCreationWriter(Writer writer, String fullSeqName, int increment, int start) INTERNAL: HSQL requires START WITH first.
  int	computeMaxRowsForSQL(int firstResultIndex, int maxResults) INTERNAL: Use the JDBC maxResults and firstResultIndex setting to compute a value to use when limiting the results of a query in SQL.
  ValueReadQuery	getTimestampQuery() This method can be overridden by subclasses to return a query that will return the timestamp from the server.
  boolean	isAlterSequenceObjectSupported() INTERNAL: Override this method if the platform supports sequence objects and it's possible to alter sequence object's increment in the database.
  boolean	isDynamicSQLRequiredForFunctions() INTERNAL HSQL has some issues with using parameters on certain functions and relations.
  boolean	isHSQL()
  void	printFieldIdentityClause(Writer writer) Append the receiver's field 'identity' constraint clause to a writer.
  void	printSQLSelectStatement(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call, org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter printer, org.eclipse.persistence.internal.expressions.SQLSelectStatement statement) Print the pagination SQL using HSQL syntax "SELECT LIMIT ".
  boolean	shouldUseJDBCOuterJoinSyntax() JDBC escape syntax for outer joins is not supported (not required).
  boolean	supportsGlobalTempTables() INTERNAL: Indicates whether the platform supports global temporary tables.
  boolean	supportsIdentity() INTERNAL: Indicates whether the platform supports identity.
  boolean	supportsNestingOuterJoins() Does not allow nesting outer joins, i.e.
  boolean	supportsSequenceObjects() INTERNAL: Indicates whether the platform supports sequence objects.
  boolean	supportsUniqueColumns() HSQL (1.8.1) does not support the UNIQUE key word in a column, but does support unique constraints defined separately.
  static ExpressionOperator	toNumberOperator() INTERNAL: Use CONVERT function for toNumber.
  static ExpressionOperator	trimOperator() INTERNAL: Use TRIM(FROM ?) function for trim.
  void	writeUpdateOriginalFromTempTableSql(Writer writer, org.eclipse.persistence.internal.helper.DatabaseTable table, Collection pkFields, Collection assignedFields) INTERNAL: HSQL does not allow multiple fields to be set as a list, so each field needs to be set one by one.

  Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  addBatch, addStructConverter, allowsSizeInProcedureArguments, appendLiteralToCall, appendParameter, appendParameterInternal, autoCommit, beginTransaction, buildCallWithReturning, buildCreateIndex, buildDropIndex, buildProcedureCallString, buildSelectQueryForIdentity, buildSelectQueryForSequenceObject, buildSequenceObjectAlterIncrementWriter, buildSequenceObjectDeletionWriter, canBatchWriteWithOptimisticLocking, canBuildCallWithReturning, commitTransaction, convertToDatabaseType, copyInto, createArray, createArray, createStruct, createStruct, dontBindUpdateAllQueryUsingTempTables, executeBatch, executeStoredProcedure, freeTemporaryObject, getAssignmentString, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getCastSizeForVarcharParameter, getClassTypes, getConnection, getConstraintDeletionString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getCustomModifyValueForCall, getDefaultSequenceTableName, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIdentifierQuoteCharacter, getInOutputProcedureToken, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJdbcTypeName, getMaxBatchWritingSize, getMaxFieldNameSize, getMaxForeignKeyNameSize, getMaxIndexNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getObjectFromResultSet, getOutputProcedureToken, getPingSQL, getProcedureArgumentSetter, getProcedureArgumentString, getProcedureAsString, getProcedureBeginString, getProcedureCallHeader, getProcedureCallTail, getProcedureEndString, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTempTableForTable, getTransactionIsolation, getTypeConverters, initialize, isCastRequired, isForUpdateCompatibleWithDistinct, isInformixOuterJoin, isLockTimeoutException, isNullAllowedInSelectClause, isXDBDocument, maximumNumericValues, minimumNumericValues, prepareBatchStatement, printFieldNotNullClause, printFieldNullClause, printFieldTypeSize, printFieldUnique, printValuelist, printValuelist, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresProcedureCallBrackets, requiresProcedureCallOuputToken, requiresTypeNameToRegisterOutputParameter, requiresUniqueConstraintCreationOnTableCreate, rollbackTransaction, setCastSizeForVarcharParameter, setCursorCode, setIsCastRequired, setMaxBatchWritingSize, setParameterValueInDatabaseCall, setPingSQL, setPrintOuterJoinInWhereClause, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldBindLiterals, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setShouldUseRownumFiltering, setStatementCacheSize, setStringBindingSize, setSupportsAutoCommit, setTransactionIsolation, setUsesBatchWriting, setUsesByteArrayBinding, setUsesJDBCBatchWriting, setUsesNativeBatchWriting, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldCreateIndicesForPrimaryKeys, shouldCreateIndicesOnUniqueKeys, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldNativeSequenceUseTransaction, shouldOptimizeDataConversion, shouldPrintAliasForUpdate, shouldPrintConstraintNameAfter, shouldPrintFieldIdentityClause, shouldPrintInOutputTokenBeforeType, shouldPrintInputTokenAtStart, shouldPrintLockingClauseAfterWhereClause, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenAtStart, shouldPrintOutputTokenBeforeType, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsForeignKeyConstraints, supportsIndividualTableLocking, supportsLocalTempTables, supportsLockingQueriesWithMultipleTables, supportsNativeSequenceNumbers, supportsOuterJoinsWithBrackets, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueKeyConstraints, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeInsertIntoTableSql, writeLOB, writeParameterMarker

  Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

  addSequence, clone, convertObject, createConnectionCustomizer, getConversionManager, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultSequence, getDefaultSequenceToWrite, getEndDelimiter, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequences, getSequencesToWrite, getStartDelimiter, getTableQualifier, getTimestampFromServer, getUpdateSequenceQuery, hasDefaultSequence, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isFirebird, isH2, isInformix, isMySQL, isODBC, isOracle, isOracle9, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, setConversionManager, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, toString, usesPlatformDefaultSequence

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  HSQLPlatform

  public HSQLPlatform()

  Method Detail

  toNumberOperator

  public static ExpressionOperator toNumberOperator()

  INTERNAL: Use CONVERT function for toNumber.

  trimOperator

  public static ExpressionOperator trimOperator()

  INTERNAL: Use TRIM(FROM ?) function for trim.

  isHSQL

  public boolean isHSQL()

  Specified by:

  isHSQL in interface org.eclipse.persistence.internal.databaseaccess.Platform

  Overrides:

  isHSQL in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

  supportsUniqueColumns

  public boolean supportsUniqueColumns()

  HSQL (1.8.1) does not support the UNIQUE key word in a column, but does support unique constraints defined separately. This allows the column setting to be generated as a constraint.

  Overrides:

  supportsUniqueColumns in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  supportsIdentity

  public boolean supportsIdentity()

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  INTERNAL: Indicates whether the platform supports identity. This method is to be used *ONLY* by sequencing classes

  Overrides:

  supportsIdentity in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  buildSelectQueryForIdentity

  public ValueReadQuery buildSelectQueryForIdentity()

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  INTERNAL: Returns query used to read back the value generated by Identity. This method is called when identity NativeSequence is connected, the returned query used until the sequence is disconnected. If the platform supportsIdentity then (at least) one of buildSelectQueryForIdentity methods should return non-null query.

  Overrides:

  buildSelectQueryForIdentity in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  printFieldIdentityClause

  public void printFieldIdentityClause(Writer writer)
                                throws ValidationException

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

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

  Overrides:

  printFieldIdentityClause in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  Throws:

  ValidationException

  isDynamicSQLRequiredForFunctions

  public boolean isDynamicSQLRequiredForFunctions()

  INTERNAL HSQL has some issues with using parameters on certain functions and relations. This allows statements to disable binding only in these cases.

  Overrides:

  isDynamicSQLRequiredForFunctions in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  shouldUseJDBCOuterJoinSyntax

  public boolean shouldUseJDBCOuterJoinSyntax()

  JDBC escape syntax for outer joins is not supported (not required).

  Overrides:

  shouldUseJDBCOuterJoinSyntax in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  supportsNestingOuterJoins

  public boolean supportsNestingOuterJoins()

  Does not allow nesting outer joins, i.e. each join must be followed by the ON clause.

  Overrides:

  supportsNestingOuterJoins in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  supportsSequenceObjects

  public boolean supportsSequenceObjects()

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  INTERNAL: Indicates whether the platform supports sequence objects. This method is to be used *ONLY* by sequencing classes

  Overrides:

  supportsSequenceObjects in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  isAlterSequenceObjectSupported

  public boolean isAlterSequenceObjectSupported()

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  INTERNAL: Override this method if the platform supports sequence objects and it's possible to alter sequence object's increment in the database.

  Overrides:

  isAlterSequenceObjectSupported in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  buildSelectQueryForSequenceObject

  public ValueReadQuery buildSelectQueryForSequenceObject(String seqName,
                                                          Integer size)

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence). In case the other version of this method (taking no parameters) returns null, this method is called every time sequence object NativeSequence reads. If the platform supportsSequenceObjects then (at least) one of buildSelectQueryForSequenceObject methods should return non-null query.

  Overrides:

  buildSelectQueryForSequenceObject in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  supportsGlobalTempTables

  public boolean supportsGlobalTempTables()

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  INTERNAL: Indicates whether the platform supports global temporary tables. "Global" means that an attempt to create temporary table with the same name for the second time results in exception. EclipseLink attempts to create global temporary table in the beginning of UpdateAllQuery, execution and assumes that it already exists in case SQLException results. In the end of UpdateAllQuery execution all rows are removed from the temporary table - it is necessary in case the same temporary table will be used by another UpdateAllQuery in the same transaction. Override this method if the platform supports global temporary tables. Note that this method is ignored in case supportsLocalTempTables() returns true.

  Overrides:

  supportsGlobalTempTables in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  writeUpdateOriginalFromTempTableSql

  public void writeUpdateOriginalFromTempTableSql(Writer writer,
                                                  org.eclipse.persistence.internal.helper.DatabaseTable table,
                                                  Collection pkFields,
                                                  Collection assignedFields)
                                           throws IOException

  INTERNAL: HSQL does not allow multiple fields to be set as a list, so each field needs to be set one by one.

  Overrides:

  writeUpdateOriginalFromTempTableSql in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  Throws:

  IOException

  computeMaxRowsForSQL

  public int computeMaxRowsForSQL(int firstResultIndex,
                                  int maxResults)

  INTERNAL: Use the JDBC maxResults and firstResultIndex setting to compute a value to use when limiting the results of a query in SQL. These limits tend to be used in two ways. 1. MaxRows is the index of the last row to be returned (like JDBC maxResults) 2. MaxRows is the number of rows to be returned HSQL uses case #2 and therefore the maxResults has to be altered based on the firstResultIndex.

  Overrides:

  computeMaxRowsForSQL in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  See Also:

  MySQLPlatform

  printSQLSelectStatement

  public void printSQLSelectStatement(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call,
                                      org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter printer,
                                      org.eclipse.persistence.internal.expressions.SQLSelectStatement statement)

  Print the pagination SQL using HSQL syntax "SELECT LIMIT ".

  Overrides:

  printSQLSelectStatement in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  getTimestampQuery

  public ValueReadQuery getTimestampQuery()

  Description copied from class: org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

  This method can be overridden by subclasses to return a query that will return the timestamp from the server. return null if the time should be the local time.

  Specified by:

  getTimestampQuery in interface org.eclipse.persistence.internal.databaseaccess.Platform

  Overrides:

  getTimestampQuery in class org.eclipse.persistence.internal.databaseaccess.DatasourcePlatform

  buildSequenceObjectCreationWriter

  public Writer buildSequenceObjectCreationWriter(Writer writer,
                                                  String fullSeqName,
                                                  int increment,
                                                  int start)
                                           throws IOException

  INTERNAL: HSQL requires START WITH first.

  Overrides:

  buildSequenceObjectCreationWriter in class org.eclipse.persistence.internal.databaseaccess.DatabasePlatform

  Throws:

  IOException