org.eclipse.persistence.platform.database

Class InformixPlatform

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CorePlatform<ConversionManager>, Platform

Direct Known Subclasses:

Informix11Platform

public class InformixPlatform
extends DatabasePlatform

Purpose: Provides Informix specific behavior.

Responsibilities:

• Types for schema creation.
• Native sequencing using @@SERIAL.

Since:

TOPLink/Java 1.0.1

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, IS_VALID_TIMEOUT, shouldIgnoreCaseOnFieldComparisons, Types_NCLOB, Types_SQLXML

Constructor Summary

Constructors

Constructor and Description
InformixPlatform()

Method Summary

Modifier and Type	Method and Description
ValueReadQuery	buildSelectQueryForIdentity() INTERNAL: Build the identity query for native sequencing.
ValueReadQuery	buildSelectQueryForSequenceObject(java.lang.String qualifiedSeqName, java.lang.Integer size) INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence).
int	getMaxFieldNameSize() INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.
java.lang.String	getSelectForUpdateString() Informix seems to like this syntax instead of the OF * syntax.
void	initializeConnectionData(java.sql.Connection connection) INTERNAL: Allow initialization from the connection.
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	isInformix()
boolean	isInformixOuterJoin() Some database require outer joins to be given in the where clause, others require it in the from clause.
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	printFieldIdentityClause(java.io.Writer writer) Append the receiver's field serial constraint clause to a writer.
void	printFieldTypeSize(java.io.Writer writer, FieldDefinition field, FieldTypeDefinition fieldType, boolean shouldPrintFieldIdentityClause) Append the field type to a writer unless the field uses an Identity strategy to generate its value.
boolean	requiresProcedureCallBrackets() Used for sp calls.
boolean	shouldPrintConstraintNameAfter() Some Platforms want the constraint name after the constraint definition.
boolean	shouldSelectIncludeOrderBy() Informix seemed to require this at some point.
boolean	supportsIdentity() INTERNAL: Indicates whether the platform supports identity.
boolean	supportsSequenceObjects() INTERNAL: Indicates whether the platform supports sequence objects.

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

addBatch, addStructConverter, allowsSizeInProcedureArguments, appendLiteralToCall, appendParameter, appendParameterInternal, autoCommit, beginTransaction, buildBatchCriteria, buildBatchCriteriaForComplexId, buildCallWithReturning, buildCreateIndex, buildCreateIndex, buildDropIndex, buildDropIndex, buildProcedureCallString, buildSequenceObjectAlterIncrementWriter, buildSequenceObjectCreationWriter, buildSequenceObjectDeletionWriter, canBatchWriteWithOptimisticLocking, canBuildCallWithReturning, commitTransaction, computeMaxRowsForSQL, convertToDatabaseType, copyInto, createArray, createArray, createStruct, createStruct, dontBindUpdateAllQueryUsingTempTables, executeBatch, executeStoredProcedure, freeTemporaryObject, getAssignmentString, getBatchBeginString, getBatchDelimiterString, getBatchEndString, getBatchRowCountAssignString, getBatchRowCountDeclareString, getBatchRowCountReturnString, getBatchWritingMechanism, getCastSizeForVarcharParameter, getClassTypes, getConnection, getConnectionUserName, getConstraintDeletionString, getCreateDatabaseSchemaString, getCreateViewString, getCreationInOutputProcedureToken, getCreationOutputProcedureToken, getCursorCode, getCustomModifyValueForCall, getDefaultSequenceTableName, getDriverSupportsNVarChar, getDropCascadeString, getDropDatabaseSchemaString, getFieldTypeDefinition, getFieldTypes, getFunctionCallHeader, getIdentifierQuoteCharacter, getIndexNamePrefix, getInOutputProcedureToken, getInputProcedureToken, getJDBCOuterJoinString, getJDBCType, getJDBCType, getJDBCTypeForSetNull, getJdbcTypeName, getMaxBatchWritingSize, getMaxForeignKeyNameSize, getMaxIndexNameSize, getMaxUniqueKeyNameSize, getNoWaitString, getObjectFromResultSet, getOutputProcedureToken, getPartitioningCallback, getPingSQL, getProcedureArgumentSetter, getProcedureArgumentString, getProcedureAsString, getProcedureBeginString, getProcedureCallHeader, getProcedureCallTail, getProcedureEndString, getQualifiedName, getQualifiedSequenceTableName, getRefValue, getRefValue, getSelectForUpdateNoWaitString, getSelectForUpdateOfString, getSelectForUpdateWaitString, getSequenceCounterFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getStatementCacheSize, getStoredProcedureParameterPrefix, getStoredProcedureTerminationToken, getStringBindingSize, getStructConverters, getTableCreationSuffix, getTempTableForTable, getTransactionIsolation, getTypeConverters, getUniqueConstraintDeletionString, getUseNationalCharacterVaryingTypeForString, getVPDClearIdentifierQuery, getVPDCreationFunctionString, getVPDCreationPolicyString, getVPDDeletionString, getVPDSetIdentifierQuery, hasPartitioningCallback, initialize, isCastRequired, isDynamicSQLRequiredForFunctions, isForUpdateCompatibleWithDistinct, isJDBCExecuteCompliant, isLobCompatibleWithDistinct, isLockTimeoutException, isNullAllowedInSelectClause, isOutputAllowWithResultSet, isRowCountOutputParameterRequired, isXDBDocument, minimumTimeIncrement, prepareBatchStatement, printFieldNotNullClause, printFieldNullClause, printFieldUnique, printSQLSelectStatement, printStoredFunctionReturnKeyWord, printValuelist, printValuelist, registerOutputParameter, requiresNamedPrimaryKeyConstraints, requiresProcedureBrackets, requiresProcedureCallOuputToken, requiresTableInIndexDropDDL, requiresTypeNameToRegisterOutputParameter, requiresUniqueConstraintCreationOnTableCreate, retrieveFirstPrimaryKeyOrOne, rollbackTransaction, setBatchWritingMechanism, setCastSizeForVarcharParameter, setCursorCode, setDriverName, setDriverSupportsNVarChar, setIsCastRequired, setMaxBatchWritingSize, setParameterValueInDatabaseCall, setPartitioningCallback, setPingSQL, setPrintInnerJoinInWhereClause, setPrintOuterJoinInWhereClause, setSequenceCounterFieldName, setSequenceNameFieldName, setSequenceTableName, setShouldBindAllParameters, setShouldBindLiterals, setShouldCacheAllStatements, setShouldCreateIndicesOnForeignKeys, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setShouldUseRownumFiltering, setStatementCacheSize, setStoredProcedureTerminationToken, setStringBindingSize, setSupportsAutoCommit, setTableCreationSuffix, setTransactionIsolation, setUseJDBCStoredProcedureSyntax, setUseNationalCharacterVaryingTypeForString, setUsesBatchWriting, setUsesByteArrayBinding, setUsesJDBCBatchWriting, setUsesNativeBatchWriting, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, shouldAlwaysUseTempStorageForModifyAll, shouldBindAllParameters, shouldBindLiterals, shouldCacheAllStatements, shouldCreateIndicesForPrimaryKeys, shouldCreateIndicesOnForeignKeys, shouldCreateIndicesOnUniqueKeys, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldIgnoreException, shouldOptimizeDataConversion, shouldPrintAliasForUpdate, shouldPrintFieldIdentityClause, shouldPrintForUpdateClause, shouldPrintInnerJoinInWhereClause, shouldPrintInOutputTokenBeforeType, shouldPrintInputTokenAtStart, shouldPrintLockingClauseAfterWhereClause, shouldPrintOuterJoinInWhereClause, shouldPrintOutputTokenAtStart, shouldPrintOutputTokenBeforeType, shouldPrintStoredProcedureArgumentNameInCall, shouldPrintStoredProcedureVariablesAfterBeginString, shouldTrimStrings, shouldUseCustomModifyForCall, shouldUseGetSetNString, shouldUseJDBCOuterJoinSyntax, shouldUseRownumFiltering, supportsANSIInnerJoinSyntax, supportsAutoCommit, supportsAutoConversionToNumericForArithmeticOperations, supportsConnectionUserName, supportsCountDistinctWithMultipleFields, supportsDeleteOnCascade, supportsForeignKeyConstraints, supportsGlobalTempTables, supportsIndexes, supportsIndividualTableLocking, supportsLocalTempTables, supportsLockingQueriesWithMultipleTables, supportsNestingOuterJoins, supportsOuterJoinsWithBrackets, supportsPrimaryKeyConstraint, supportsStoredFunctions, supportsTempTables, supportsUniqueColumns, supportsUniqueKeyConstraints, supportsVPD, usesBatchWriting, usesByteArrayBinding, usesJDBCBatchWriting, usesNativeBatchWriting, usesNativeSQL, usesSequenceTable, usesStreamsForBinding, usesStringBinding, wasFailureCommunicationBased, writeAddColumnClause, writeCleanUpTempTableSql, writeCreateTempTableSql, writeDeleteFromTargetTableUsingTempTableSql, writeInsertIntoTableSql, writeLOB, writeParameterMarker, writeTableCreationSuffix, writeUpdateOriginalFromTempTableSql

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

addSequence, addSequence, buildNativeCall, buildSelectQueryForIdentity, buildSelectQueryForSequenceObject, clone, convertObject, createConnectionCustomizer, getConversionManager, getDataTypesConvertedFrom, getDataTypesConvertedTo, getDefaultNativeSequenceToTable, getDefaultSequence, getDefaultSequenceToWrite, getEndDelimiter, getOperator, getPlatformOperators, getSelectSequenceQuery, getSequence, getSequences, getSequencesToWrite, getStartDelimiter, getTableQualifier, getTimestampFromServer, getTimestampQuery, getUpdateSequenceQuery, hasDefaultSequence, initializeDefaultQueries, isAccess, isAttunity, isCloudscape, isDB2, isDBase, isDerby, isFirebird, isH2, isHANA, isHSQL, isMaxDB, isMySQL, isODBC, isOracle, isOracle9, isPervasive, isPointBase, isPostgreSQL, isSQLAnywhere, isSQLServer, isSybase, isSymfoware, isTimesTen, isTimesTen7, removeAllSequences, removeSequence, setConversionManager, setDefaultNativeSequenceToTable, setDefaultSequence, setEndDelimiter, setSelectSequenceNumberQuery, setSequencePreallocationSize, setSequences, setStartDelimiter, setTableQualifier, setTimestampQuery, setUpdateSequenceQuery, shouldNativeSequenceUseTransaction, shouldPrepare, shouldSelectDistinctIncludeOrderBy, supportsNativeSequenceNumbers, toString, usesPlatformDefaultSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

InformixPlatform

public InformixPlatform()

Method Detail

initializeConnectionData

public void initializeConnectionData(java.sql.Connection connection)
                              throws java.sql.SQLException

Description copied from class: DatabasePlatform

INTERNAL: Allow initialization from the connection.

Overrides:

initializeConnectionData in class DatabasePlatform

Throws:

java.sql.SQLException

buildSelectQueryForIdentity

public ValueReadQuery buildSelectQueryForIdentity()

INTERNAL: Build the identity query for native sequencing.

Overrides:

buildSelectQueryForIdentity in class DatasourcePlatform

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

getSelectForUpdateString

public java.lang.String getSelectForUpdateString()

Informix seems to like this syntax instead of the OF * syntax.

Overrides:

getSelectForUpdateString in class DatabasePlatform

isInformix

public boolean isInformix()

Specified by:

isInformix in interface Platform

Overrides:

isInformix in class DatasourcePlatform

isInformixOuterJoin

public boolean isInformixOuterJoin()

Some database require outer joins to be given in the where clause, others require it in the from clause. Informix requires it in the from clause with no ON expression.

Overrides:

isInformixOuterJoin in class DatabasePlatform

shouldSelectIncludeOrderBy

public boolean shouldSelectIncludeOrderBy()

Informix seemed to require this at some point. Not sure if it still does.

Overrides:

shouldSelectIncludeOrderBy in class DatasourcePlatform

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

printFieldTypeSize

public void printFieldTypeSize(java.io.Writer writer,
                               FieldDefinition field,
                               FieldTypeDefinition fieldType,
                               boolean shouldPrintFieldIdentityClause)
                        throws java.io.IOException

Append the field type to a writer unless the field uses an Identity strategy to generate its value. In this case, the field type 'SERIAL' will be appended later.

Overrides:

printFieldTypeSize in class DatabasePlatform

Throws:

java.io.IOException

printFieldIdentityClause

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

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

Overrides:

printFieldIdentityClause in class DatabasePlatform

Throws:

ValidationException

requiresProcedureCallBrackets

public boolean requiresProcedureCallBrackets()

Used for sp calls.

Overrides:

requiresProcedureCallBrackets in class DatabasePlatform

shouldPrintConstraintNameAfter

public boolean shouldPrintConstraintNameAfter()

Some Platforms want the constraint name after the constraint definition.

Overrides:

shouldPrintConstraintNameAfter in class DatabasePlatform

supportsIdentity

public boolean supportsIdentity()

INTERNAL: Indicates whether the platform supports identity. Informix does this through SERIAL field types. This method is to be used *ONLY* by sequencing classes

Overrides:

supportsIdentity in class DatasourcePlatform

supportsSequenceObjects

public boolean supportsSequenceObjects()

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

Overrides:

supportsSequenceObjects in class DatasourcePlatform

buildSelectQueryForSequenceObject

public ValueReadQuery buildSelectQueryForSequenceObject(java.lang.String qualifiedSeqName,
                                                        java.lang.Integer size)

INTERNAL: Returns query used to read value generated by sequence object (like Oracle sequence). This method is called when sequence object NativeSequence is connected, the returned query used until the sequence is disconnected. If the platform supportsSequenceObjects then (at least) one of buildSelectQueryForSequenceObject methods should return non-null query.

Overrides:

buildSelectQueryForSequenceObject in class DatasourcePlatform

isAlterSequenceObjectSupported

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

Overrides:

isAlterSequenceObjectSupported in class DatabasePlatform