org.apache.openjpa.jdbc.sql
Class InformixDictionary
java.lang.Object
   org.apache.openjpa.jdbc.sql.DBDictionary
org.apache.openjpa.jdbc.sql.DBDictionary
       org.apache.openjpa.jdbc.sql.InformixDictionary
org.apache.openjpa.jdbc.sql.InformixDictionary
- All Implemented Interfaces: 
- JoinSyntaxes, Configurable, IdentifierConfiguration, ConnectionDecorator, LoggingConnectionDecorator.SQLWarningHandler
- public class InformixDictionary 
- extends DBDictionary
Dictionary for Informix database. Notable features:
 
 - Informix does not allow pessimistic locking on scrollable result
 sets.
- SET LOCK MODE TO WAIT N statements are issued to wait on locks. See
 lockWaitSecondsandlockModeEnabled.
- LOCK MODE ROW is used by default for table creation to allow the
 maximum concurrency.
 
 
| Field Summary | 
|  boolean | lockModeEnabledIf true, then we will issue a "SET LOCK MODE TO WAIT N"
 statement whenever we create a
 Connection, in order
 allow waiting on locks. | 
|  int | lockWaitSecondsIf
 lockModeEnabledistrue, then this
 parameter specifies the number of seconds we will wait to
 obtain a lock for inserts and pessimistic locking. | 
|  boolean | swapSchemaAndCatalogInformix JDBC metadata for all known drivers returns with the
 table catalog and the table schema name swapped.
 | 
| protected  boolean | useJCC
 | 
| static String | VENDOR_IBM
 | 
 
| Fields inherited from class org.apache.openjpa.jdbc.sql.DBDictionary | 
| allowsAliasInBulkClause, arrayTypeName, autoAssignClause, autoAssignTypeName, batchLimit, bigintTypeName, binaryTypeName, bitLengthFunction, bitTypeName, blobBufferSize, blobTypeName, booleanTypeName, castFunction, catalogSeparator, CENTI, characterColumnSize, charTypeName, clobBufferSize, clobTypeName, closePoolSQL, concatenateDelimiter, concatenateFunction, conf, connected, CONS_NAME_AFTER, CONS_NAME_BEFORE, CONS_NAME_MID, constraintNameMode, createPrimaryKeys, crossJoinClause, currentDateFunction, currentTimeFunction, currentTimestampFunction, datePrecision, dateTypeName, DECI, decimalTypeName, delimitedCase, distinctCountColumnSeparator, distinctTypeName, doubleTypeName, driverVendor, dropTableSQL, fixedSizeTypeNames, fixedSizeTypeNameSet, floatTypeName, forUpdateClause, getStringVal, inClauseLimit, initializationSQL, innerJoinClause, integerTypeName, invalidColumnWordSet, isJDBC3, isJDBC4, javaObjectTypeName, joinSyntax, lastGeneratedKeyQuery, leadingDelimiter, log, longVarbinaryTypeName, longVarcharTypeName, maxAutoAssignNameLength, maxColumnNameLength, maxConstraintNameLength, maxEmbeddedBlobSize, maxEmbeddedClobSize, maxIndexesPerTable, maxIndexNameLength, maxTableNameLength, MICRO, MILLI, NAME_ANY, NAME_SEQUENCE, NAME_TABLE, nameConcatenator, NANO, nativeSequenceType, nextSequenceQuery, NO_BATCH, nullTypeName, numericTypeName, otherTypeName, outerJoinClause, platform, RANGE_POST_DISTINCT, RANGE_POST_LOCK, RANGE_POST_SELECT, RANGE_PRE_DISTINCT, rangePosition, realTypeName, refTypeName, reportsSuccessNoInfoOnBatchUpdates, requiresAliasForSubselect, requiresAutoCommitForMetaData, requiresCastForComparisons, requiresCastForMathFunctions, requiresConditionForCrossJoin, requiresSearchStringEscapeForLike, requiresTargetForDelete, reservedWords, reservedWordSet, SCHEMA_CASE_LOWER, SCHEMA_CASE_PRESERVE, SCHEMA_CASE_UPPER, schemaCase, searchStringEscape, SEC, selectWords, selectWordSet, sequenceNameSQL, sequenceSchemaSQL, sequenceSQL, setStringRightTruncationOn, simulateLocking, smallintTypeName, sqlStateCodes, storageLimitationsFatal, storeCharsAsNumbers, storeLargeNumbersAsStrings, stringLengthFunction, structTypeName, substringFunctionName, supportsAlterTableWithAddColumn, supportsAlterTableWithDropColumn, supportsAutoAssign, supportsCascadeDeleteAction, supportsCascadeUpdateAction, supportsCaseConversionForLob, supportsComments, supportsCorrelatedSubselect, supportsDefaultDeleteAction, supportsDefaultUpdateAction, supportsDeferredConstraints, supportsDelimitedIdentifiers, supportsForeignKeys, supportsForeignKeysComposite, supportsGeneralCaseExpression, supportsGetGeneratedKeys, supportsHaving, supportsLockingWithDistinctClause, supportsLockingWithInnerJoin, supportsLockingWithMultipleTables, supportsLockingWithOrderClause, supportsLockingWithOuterJoin, supportsLockingWithSelectRange, supportsModOperator, supportsMultipleNontransactionalResultSets, supportsNullDeleteAction, supportsNullTableForGetColumns, supportsNullTableForGetImportedKeys, supportsNullTableForGetIndexInfo, supportsNullTableForGetPrimaryKeys, supportsNullUniqueColumn, supportsNullUpdateAction, supportsParameterInSelect, supportsQueryTimeout, supportsRestrictDeleteAction, supportsRestrictUpdateAction, supportsSchemaForGetColumns, supportsSchemaForGetTables, supportsSelectEndIndex, supportsSelectForUpdate, supportsSelectFromFinalTable, supportsSelectStartIndex, supportsSimpleCaseExpression, supportsSubselect, supportsUniqueConstraints, supportsXMLColumn, systemSchemas, systemSchemaSet, systemTables, systemTableSet, tableForUpdateClause, tableTypes, timestampTypeName, timeTypeName, tinyintTypeName, toLowerCaseFunction, toUpperCaseFunction, trailingDelimiter, trimBothFunction, trimLeadingFunction, trimSchemaName, trimTrailingFunction, typeModifierSet, UNLIMITED, useGetBestRowIdentifierForPrimaryKeys, useGetBytesForBlobs, useGetObjectForBlobs, useGetStringForClobs, useSchemaName, useSetBytesForBlobs, useSetStringForClobs, useWildCardForCount, validationSQL, varbinaryTypeName, varcharTypeName, VENDOR_DATADIRECT, VENDOR_OTHER, xmlTypeEncoding, xmlTypeName | 
 
 
 
| Method Summary | 
|  void | connectedConfiguration(Connection conn)This method is called when the dictionary first sees any connection.
 | 
|  Connection | decorate(Connection conn)Decorate the given connection if needed.
 | 
|  String[] | getAddForeignKeySQL(ForeignKey fk)Return a series of SQL statements to add the given foreign key to
 its table.
 | 
|  String[] | getAddPrimaryKeySQL(PrimaryKey pk)Return a series of SQL statements to add the given primary key to
 its table.
 | 
|  Column[] | getColumns(DatabaseMetaData meta,
           DBIdentifier catalog,
           DBIdentifier schemaName,
           DBIdentifier tableName,
           DBIdentifier columnName,
           Connection conn)Reflect on the schema to find columns matching the given table and
 column patterns.
 | 
|  Column[] | getColumns(DatabaseMetaData meta,
           String catalog,
           String schemaName,
           String tableName,
           String columnName,
           Connection conn)Reflect on the schema to find columns matching the given table and
 column patterns.
 | 
|  String[] | getCreateTableSQL(Table table)Return a series of SQL statements to create the given table, complete
 with columns.
 | 
|  String | getSchemaCase()Return DB specific schemaCase
 | 
|  void | indexOf(SQLBuffer buf,
        FilterValue str,
        FilterValue find,
        FilterValue start)Invoke this database's indexOf function.
 | 
|  boolean | isFatalException(int subtype,
                 SQLException ex)Determine if the given SQL Exception is fatal or recoverable (such as a timeout).
 | 
| protected  int | matchErrorState(Map<Integer,Set<String>> errorStates,
                SQLException ex)Specialized matchErrorState method for Informix.
 | 
|  boolean | needsToCreateIndex(Index idx,
                   Table table)
 | 
|  Column | newColumn(ResultSet colMeta)Create a new column from the information in the schema metadata.
 | 
|  Index | newIndex(ResultSet idxMeta)Create a new index from the information in the schema metadata.
 | 
|  PrimaryKey | newPrimaryKey(ResultSet pkMeta)Create a new primary key from the information in the schema metadata.
 | 
|  void | setBoolean(PreparedStatement stmnt,
           int idx,
           boolean val,
           Column col)Set the given value as a parameter to the statement.
 | 
|  boolean | supportsRandomAccessResultSet(Select sel,
                              boolean forUpdate)Return false if the given select requires a forward-only result set.
 | 
|  boolean | useJCC()
 | 
 
| Methods inherited from class org.apache.openjpa.jdbc.sql.DBDictionary | 
| addCastAsType, addErrorCode, appendCast, appendLength, appendNumericCast, appendSelect, appendSelectRange, appendSize, appendUpdates, appendXmlComparison, assertSupport, calculateValue, canOuterJoin, checkNameLength, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, deleteStream, delimitAll, endConfiguration, executeQuery, fromDBName, getAddColumnSQL, getArray, getAsciiStream, getBatchFetchSize, getBatchLimit, getBatchUpdateCount, getBigDecimal, getBigInteger, getBinaryStream, getBlob, getBlobObject, getBoolean, getByte, getBytes, getCalendar, getCastFunction, getCastFunction, getCatalogNameForMetadata, getCatalogNameForMetadata, getChar, getCharacterStream, getClob, getClobString, getColumnDBName, getColumnIdentifier, getColumnNameForMetadata, getColumnNameForMetadata, getConversionKey, getCreateIndexSQL, getCreateSequenceSQL, getCreateTableSQL, getDate, getDate, getDeclareColumnSQL, getDefaultIdentifierRule, getDefaultSchemaName, getDeleteTableContentsSQL, getDeleteTargets, getDelimitedCase, getDelimitIdentifiers, getDouble, getDropColumnSQL, getDropForeignKeySQL, getDropIndexSQL, getDropPrimaryKeySQL, getDropSequenceSQL, getDropTableSQL, getFloat, getForeignKeyConstraintSQL, getForUpdateClause, getFrom, getFromSelect, getFullIdentifier, getFullName, getFullName, getFullName, getGeneratedKey, getGeneratedKeySequenceName, getGenKeySeqName, getIdentifierConcatenator, getIdentifierDelimiter, getIdentifierRule, getIdentifierRules, getIdentityColumnName, getImportedKeys, getImportedKeys, getImportedKeys, getImportedKeys, getIndexInfo, getIndexInfo, getInt, getInvalidColumnWordSet, getIsNotNullSQL, getIsNullSQL, getJDBCType, getJDBCType, getJDBCType, getKey, getLeadingDelimiter, getLOBStream, getLocale, getLog, getLong, getMarkerForInsertUpdate, getNamingUtil, getNumber, getObject, getPlaceholderValueString, getPreferredType, getPrimaryKeyConstraintSQL, getPrimaryKeys, getPrimaryKeys, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelectOperation, getSelects, getSelectTableAliases, getSequence, getSequences, getSequences, getSequencesSQL, getSequencesSQL, getShort, getString, getSupportsDelimitedIdentifiers, getSupportsXMLColumn, getTableNameForMetadata, getTableNameForMetadata, getTables, getTables, getTime, getTimestamp, getTrailingDelimiter, getTrimSchemaName, getTypeName, getTypeName, getUniqueConstraintSQL, getValidColumnName, getValidColumnName, getValidColumnName, getValidColumnName, getValidForeignKeyName, getValidForeignKeyName, getValidIndexName, getValidIndexName, getValidPrimaryKeyName, getValidSequenceName, getValidSequenceName, getValidTableName, getValidTableName, getValidUniqueName, getValidUniqueName, getVersionColumn, getVersionColumn, getWhere, getXMLTypeEncoding, handleWarning, insertBlobForStreamingLoad, insertClobForStreamingLoad, insertSize, isSelect, isSystemIndex, isSystemIndex, isSystemSequence, isSystemSequence, isSystemSequence, isSystemTable, isSystemTable, makeNameValid, makeNameValid, makeNameValid, makeNameValid, mathFunction, narrow, needsToCreateIndex, newForeignKey, newSequence, newStoreException, newTable, prepareStatement, putBytes, putChars, putString, refSchemaComponents, serialize, setArray, setAsciiStream, setBatchLimit, setBigDecimal, setBigInteger, setBinaryStream, setBlob, setBlobObject, setByte, setBytes, setCalendar, setChar, setCharacterStream, setClob, setClobString, setConfiguration, setDate, setDate, setDefaultSchemaName, setDelimitedCase, setDelimitIdentifiers, setDouble, setFloat, setInt, setJoinSyntax, setLeadingDelimiter, setLocale, setLong, setNull, setNumber, setObject, setQueryTimeout, setRef, setShort, setStatementQueryTimeout, setString, setSupportsDelimitedIdentifiers, setSupportsXMLColumn, setTime, setTimeouts, setTimeouts, setTimestamp, setTrailingDelimiter, setTrimSchemaName, setTyped, setUnknown, setXMLTypeEncoding, shorten, startConfiguration, storageWarning, substring, supportsDeferredForeignKeyConstraints, supportsDeferredUniqueConstraints, supportsDeleteAction, supportsIsolationForUpdate, supportsLocking, supportsUpdateAction, toBulkOperation, toDBName, toDBName, toDelete, toLong, toNativeJoin, toOperation, toOperation, toSelect, toSelect, toSelect, toSelect, toSelect, toSelectCount, toSQL92Join, toTraditionalJoin, toUpdate, updateBlob, updateClob, validateBatchProcess, validateDBSpecificBatchProcess | 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
VENDOR_IBM
public static final String VENDOR_IBM
- See Also:
- Constant Field Values
lockModeEnabled
public boolean lockModeEnabled
- If true, then we will issue a "SET LOCK MODE TO WAIT N"
 statement whenever we create a Connection, in order
 allow waiting on locks.
 
 
lockWaitSeconds
public int lockWaitSeconds
- If lockModeEnabledistrue, then this
 parameter specifies the number of seconds we will wait to
 obtain a lock for inserts and pessimistic locking.
 
 
swapSchemaAndCatalog
public boolean swapSchemaAndCatalog
- Informix JDBC metadata for all known drivers returns with the
 table catalog and the table schema name swapped. A truevalue for this property indicates that they should be reversed.
 
 
useJCC
protected boolean useJCC
InformixDictionary
public InformixDictionary()
connectedConfiguration
public void connectedConfiguration(Connection conn)
                            throws SQLException
- Description copied from class: DBDictionary
- This method is called when the dictionary first sees any connection.
 It is used to initialize dictionary metadata if needed. If you
 override this method, be sure to call
 super.connectedConfiguration.
 
- 
- Overrides:
- connectedConfigurationin class- DBDictionary
 
- 
- Throws:
- SQLException
 
getColumns
public Column[] getColumns(DatabaseMetaData meta,
                           String catalog,
                           String schemaName,
                           String tableName,
                           String columnName,
                           Connection conn)
                    throws SQLException
- Description copied from class: DBDictionary
- Reflect on the schema to find columns matching the given table and
 column patterns.
 
- 
- Overrides:
- getColumnsin class- DBDictionary
 
- 
- Throws:
- SQLException
 
getColumns
public Column[] getColumns(DatabaseMetaData meta,
                           DBIdentifier catalog,
                           DBIdentifier schemaName,
                           DBIdentifier tableName,
                           DBIdentifier columnName,
                           Connection conn)
                    throws SQLException
- Description copied from class: DBDictionary
- Reflect on the schema to find columns matching the given table and
 column patterns.
 
- 
- Overrides:
- getColumnsin class- DBDictionary
 
- 
- Throws:
- SQLException
 
newColumn
public Column newColumn(ResultSet colMeta)
                 throws SQLException
- Description copied from class: DBDictionary
- Create a new column from the information in the schema metadata.
 
- 
- Overrides:
- newColumnin class- DBDictionary
 
- 
- Throws:
- SQLException
 
newPrimaryKey
public PrimaryKey newPrimaryKey(ResultSet pkMeta)
                         throws SQLException
- Description copied from class: DBDictionary
- Create a new primary key from the information in the schema metadata.
 
- 
- Overrides:
- newPrimaryKeyin class- DBDictionary
 
- 
- Throws:
- SQLException
 
newIndex
public Index newIndex(ResultSet idxMeta)
               throws SQLException
- Description copied from class: DBDictionary
- Create a new index from the information in the schema metadata.
 
- 
- Overrides:
- newIndexin class- DBDictionary
 
- 
- Throws:
- SQLException
 
setBoolean
public void setBoolean(PreparedStatement stmnt,
                       int idx,
                       boolean val,
                       Column col)
                throws SQLException
- Description copied from class: DBDictionary
- Set the given value as a parameter to the statement.
 
- 
- Overrides:
- setBooleanin class- DBDictionary
 
- 
- Throws:
- SQLException
 
getCreateTableSQL
public String[] getCreateTableSQL(Table table)
- Description copied from class: DBDictionary
- Return a series of SQL statements to create the given table, complete
 with columns. Indexes and constraints will be created separately.
 
- 
- Overrides:
- getCreateTableSQLin class- DBDictionary
 
- 
 
getAddPrimaryKeySQL
public String[] getAddPrimaryKeySQL(PrimaryKey pk)
- Description copied from class: DBDictionary
- Return a series of SQL statements to add the given primary key to
 its table. Return an empty array if operation not supported.
 Returns ALTER TABLE <table name> ADD
 <pk cons sql >by default.
 
- 
- Overrides:
- getAddPrimaryKeySQLin class- DBDictionary
 
- 
 
getAddForeignKeySQL
public String[] getAddForeignKeySQL(ForeignKey fk)
- Description copied from class: DBDictionary
- Return a series of SQL statements to add the given foreign key to
 its table. Return an empty array if operation not supported.
 Returns ALTER TABLE <table name> ADD
 <fk cons sql >by default.
 
- 
- Overrides:
- getAddForeignKeySQLin class- DBDictionary
 
- 
 
supportsRandomAccessResultSet
public boolean supportsRandomAccessResultSet(Select sel,
                                             boolean forUpdate)
- Description copied from class: DBDictionary
- Return false if the given select requires a forward-only result set.
 
- 
- Overrides:
- supportsRandomAccessResultSetin class- DBDictionary
 
- 
 
decorate
public Connection decorate(Connection conn)
                    throws SQLException
- Description copied from class: DBDictionary
- Decorate the given connection if needed. Some databases require special
 handling for JDBC bugs. This implementation issues any
 DBDictionary.initializationSQLthat has been set for the dictionary but
 does not decorate the connection.
 
- 
- Specified by:
- decoratein interface- ConnectionDecorator
- Overrides:
- decoratein class- DBDictionary
 
- 
- Throws:
- SQLException
 
indexOf
public void indexOf(SQLBuffer buf,
                    FilterValue str,
                    FilterValue find,
                    FilterValue start)
- Description copied from class: DBDictionary
- Invoke this database's indexOf function.
 
- 
- Overrides:
- indexOfin class- DBDictionary
 
- 
- Parameters:
- buf- the SQL buffer to write the indexOf invocation to
- str- a query value representing the target string
- find- a query value representing the search string
- start- a query value representing the start index, or null
 to start at the beginning
 
needsToCreateIndex
public boolean needsToCreateIndex(Index idx,
                                  Table table)
- 
- Overrides:
- needsToCreateIndexin class- DBDictionary
 
- 
 
useJCC
public boolean useJCC()
- 
 
getSchemaCase
public String getSchemaCase()
- Return DB specific schemaCase
 
- 
- Specified by:
- getSchemaCasein interface- IdentifierConfiguration
- Overrides:
- getSchemaCasein class- DBDictionary
 
- 
- Returns:
- upper, lower, or preserve
 
isFatalException
public boolean isFatalException(int subtype,
                                SQLException ex)
- Description copied from class: DBDictionary
- Determine if the given SQL Exception is fatal or recoverable (such as a timeout).
 This implementation always returns true (i.e. all exceptions are fatal).
 The current dictionary implementation can overwrite this method to mark certain
 exception conditions as recoverable error.
 
- 
- Overrides:
- isFatalExceptionin class- DBDictionary
 
- 
- Parameters:
- subtype- A constant indicating the category of error as defined in- StoreException.
- ex- original SQL Exception as raised by the database driver.
- Returns:
- false if the error is fatal.
 
matchErrorState
protected int matchErrorState(Map<Integer,Set<String>> errorStates,
                              SQLException ex)
- Specialized matchErrorState method for Informix.  Informix exceptions are
 typically nested multiple levels deep.  Correct determination of the exception type requires
 inspection of nested exceptions to determine the root cause. A list of Informix (IDS v10) error codes
 can be found here:
 
 http://publib.boulder.ibm.com/infocenter/idshelp/v10/index.jsp?topic=/com.ibm.em.doc/errors_ids100.html
 
- 
- Overrides:
- matchErrorStatein class- DBDictionary
 
- 
- Parameters:
- errorStates- classification of SQL error states by their specific nature. The keys of the
 map represent one of the constants defined in- StoreException. The value corresponding to
 a key represent the set of SQL Error States representing specific category of database error. 
 This supplied map is sourced from- sql-error-state-codes.xml and filtered the
 error states for the current database.- ex- original SQL Exception as raised by the database driver.
- Returns:
- A constant indicating the category of error as defined in StoreException.
 
Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.