OracleDictionary (OpenJPA Parent POM 3.0.0 API)

java.lang.Object
- org.apache.openjpa.jdbc.sql.DBDictionary
- - org.apache.openjpa.jdbc.sql.OracleDictionary

All Implemented Interfaces:

JoinSyntaxes, Configurable, IdentifierConfiguration, ConnectionDecorator, LoggingConnectionDecorator.SQLWarningHandler
```
public class OracleDictionary
extends DBDictionary
```
Dictionary for Oracle.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
  DBDictionary.DateMillisecondBehaviors, DBDictionary.SerializedData

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`autoAssignSequenceName` The global sequence name to use for autoassign simulation.
`boolean`	`openjpa3GeneratedKeyNames` Flag to use OpenJPA 0.3 style naming for auto assign sequence name and trigger name for backwards compatibility.
`static String`	`SELECT_HINT`
`boolean`	`supportsSetClob` Deprecated.
`boolean`	`useSetFormOfUseForUnicode` If true, then OpenJPA will attempt to use the special OraclePreparedStatement.setFormOfUse method to configure statements that it detects are operating on unicode fields.
`boolean`	`useTriggersForAutoAssign` If true, then simulate auto-assigned values in Oracle by using a trigger that inserts a sequence value into the primary key value when a row is inserted.
`static String`	`VENDOR_ORACLE`
`String`	`xmlTypeMarker` Type constructor for XML column, used in INSERT and UPDATE statements.

Fields inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
_procs, _proxyManager, allowQueryTimeoutOnFindUpdate, allowsAliasInBulkClause, arrayTypeName, autoAssignClause, autoAssignTypeName, batchLimit, bigintTypeName, binaryTypeName, bitLengthFunction, bitTypeName, blobBufferSize, blobTypeName, booleanRepresentation, 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, databaseProductName, databaseProductVersion, datePrecision, dateTypeName, DECI, decimalTypeName, defaultSchemaName, delimitedCase, disableAlterSeqenceIncrementBy, disableSchemaFactoryColumnTypeErrors, distinctCountColumnSeparator, distinctTypeName, doubleTypeName, driverVendor, dropTableSQL, fixedSizeTypeNames, fixedSizeTypeNameSet, floatTypeName, forUpdateClause, fullResultCollectionInOrderByRelation, 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, roundTimeToMillisec, 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, tableLengthIncludesSchema, tableTypes, timestampTypeName, timeTypeName, tinyintTypeName, toLowerCaseFunction, toUpperCaseFunction, trailingDelimiter, trimBothFunction, trimLeadingFunction, trimSchemaName, trimStringColumns, trimTrailingFunction, typeModifierSet, UNLIMITED, useGetBestRowIdentifierForPrimaryKeys, useGetBytesForBlobs, useGetObjectForBlobs, useGetStringForClobs, useJDBC4SetBinaryStream, useNativeSequenceCache, useSchemaName, useSetBytesForBlobs, useSetStringForClobs, useWildCardForCount, validationSQL, varbinaryTypeName, varcharTypeName, VENDOR_DATADIRECT, VENDOR_OTHER, xmlTypeEncoding, xmlTypeName

Fields inherited from interface org.apache.openjpa.jdbc.sql.JoinSyntaxes
SYNTAX_DATABASE, SYNTAX_SQL92, SYNTAX_TRADITIONAL

Constructor Summary

Constructors
Constructor and Description

OracleDictionary()

Constructors
Constructor and Description
`OracleDictionary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendXmlComparison(SQLBuffer buf, String op, FilterValue lhs, FilterValue rhs, boolean lhsxml, boolean rhsxml)` If this dictionary supports XML type, use this method to append xml predicate.
`boolean`	`canOuterJoin(int syntax, ForeignKey fk)` Returns if the given foreign key can be eagerly loaded using other joins.
`void`	`connectedConfiguration(Connection conn)` This method is called when the dictionary first sees any connection.
`void`	`endConfiguration()` Invoked upon completion of bean property configuration for this object.
`void`	`ensureDriverVendor()` Ensure that the driver vendor has been set, and if not, set it now.
`int`	`getBatchUpdateCount(PreparedStatement ps)` Return batched statements update success count
`String`	`getClobString(ResultSet rs, int column)` Convert the specified column of the SQL ResultSet to the proper java type.
`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.
`Object`	`getGeneratedKey(Column col, Connection conn)` Return the last generated value for the given column.
`protected String`	`getGeneratedKeyTriggerName(Column col)` Trigger name for simulating auto-assign values on the given column.
`ForeignKey[]`	`getImportedKeys(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, Connection conn, boolean partialKeys)` Reflect on the schema to return full foreign keys imported by the given table pattern.
`ForeignKey[]`	`getImportedKeys(DatabaseMetaData meta, String catalog, String schemaName, String tableName, Connection conn, boolean partialKeys)` Reflect on the schema to return full foreign keys imported by the given table pattern.
`Index[]`	`getIndexInfo(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, boolean unique, boolean approx, Connection conn)` Reflect on the schema to find indexes matching the given table pattern.
`Index[]`	`getIndexInfo(DatabaseMetaData meta, String catalog, String schemaName, String tableName, boolean unique, boolean approx, Connection conn)` Reflect on the schema to find indexes matching the given table pattern.
`String`	`getIsNotNullSQL(String colAlias, int colType)`
`String`	`getIsNullSQL(String colAlias, int colType)`
`int`	`getJDBCType(int metaTypeCode, boolean lob, int precis, int scale, boolean xml)` Return the preferred `Types` constant for the given `JavaTypes` or `JavaSQLTypes` constant.
`String`	`getMarkerForInsertUpdate(Column col, Object val)` Oracle requires special handling of XML column.
`Object`	`getObject(ResultSet rs, int column, Map map)` Convert the specified column of the SQL ResultSet to the proper java type.
`protected String`	`getOpenJPA3GeneratedKeySequenceName(Column col)` Returns a OpenJPA 3-compatible name for an auto-assign sequence.
`protected String`	`getOpenJPA3GeneratedKeyTriggerName(Column col)` Returns a OpenJPA 3-compatible name for an auto-assign trigger.
`PrimaryKey[]`	`getPrimaryKeys(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, Connection conn)` Reflect on the schema to find primary keys for the given table pattern.
`PrimaryKey[]`	`getPrimaryKeys(DatabaseMetaData meta, String catalog, String schemaName, String tableName, Connection conn)` Reflect on the schema to find primary keys for the given table pattern.
`String`	`getSelectOperation(JDBCFetchConfiguration fetch)` Check to see if we have set the `SELECT_HINT` in the fetch configuration, and if so, append the Oracle hint after the "SELECT" part of the query.
`protected SQLBuffer`	`getSelects(Select sel, boolean distinctIdentifiers, boolean forUpdate)` Return the portion of the select statement between the SELECT keyword and the FROM keyword.
`protected String`	`getSequencesSQL(DBIdentifier schemaName, DBIdentifier sequenceName)`
`protected String`	`getSequencesSQL(String schemaName, String sequenceName)` Return the SQL needed to select the list of sequences.
`Timestamp`	`getTimestamp(ResultSet rs, int column, Calendar cal)` Convert the specified column of the SQL ResultSet to the proper java type.
`protected void`	`guessJDBCVersion(Connection conn)` Oracle drivers, at least in versions 10.2.0.4 and 11.2.0.1, incorrectly return a driver major version from `DatabaseMetaData.getJDBCMajorVersion()`.
`void`	`indexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)` Invoke this database's indexOf function.
`void`	`insertBlobForStreamingLoad(Row row, Column col, JDBCStore store, Object ob, Select sel)`
`void`	`insertClobForStreamingLoad(Row row, Column col, Object ob)`
`boolean`	`isFatalException(int subtype, SQLException ex)` Determine if the given SQL Exception is fatal or recoverable (such as a timeout).
`boolean`	`isImplicitJoin()`
`boolean`	`isSystemSequence(DBIdentifier name, DBIdentifier schema, boolean targetSchema)` This method is used to filter system sequences from database metadata.
`boolean`	`isSystemSequence(String name, String schema, boolean targetSchema)` This method is used to filter system sequences from database metadata.
`void`	`putBytes(Blob blob, byte[] data)` Invoke Oracle's `putBytes` method on the given BLOB object.
`void`	`putChars(Clob clob, char[] data)` Invoke Oracle's `putChars` method on the given CLOB object.
`void`	`putString(Clob clob, String data)` Invoke Oracle's `putString` method on the given CLOB object.
`void`	`setBinaryStream(PreparedStatement stmnt, int idx, InputStream val, int length, Column col)` Set the given value as a parameter to the statement.
`void`	`setClobString(PreparedStatement stmnt, int idx, String val, Column col)` Set the given value as a parameter to the statement.
`void`	`setNull(PreparedStatement stmnt, int idx, int colType, Column col)` Set null as a parameter to the statement.
`void`	`setString(PreparedStatement stmnt, int idx, String val, Column col)` Set the given value as a parameter to the statement.
`boolean`	`supportsLocking(Select sel)` Returns true if a "FOR UPDATE" clause can be used for the specified Select object.
`SQLBuffer`	`toNativeJoin(Join join)` Use the given join instance to create SQL joining its tables in the database's native syntax.
`protected SQLBuffer`	`toSelect(SQLBuffer select, JDBCFetchConfiguration fetch, SQLBuffer tables, SQLBuffer where, SQLBuffer group, SQLBuffer having, SQLBuffer order, boolean distinct, boolean forUpdate, long start, long end, boolean subselect, Select sel)` Combine the given components into a SELECT statement.
`protected SQLBuffer`	`toSelect(SQLBuffer select, JDBCFetchConfiguration fetch, SQLBuffer tables, SQLBuffer where, SQLBuffer group, SQLBuffer having, SQLBuffer order, boolean distinct, boolean forUpdate, long start, long end, Select sel)` Combine the given components into a SELECT statement.

Methods inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
addCastAsType, addErrorCode, appendCast, appendLength, appendNumericCast, appendSelect, appendSelectRange, appendSize, appendUpdates, applyRange, assertSupport, calculateValue, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, decorate, deleteStream, delimitAll, executeQuery, fromDBName, getAddColumnSQL, getAddForeignKeySQL, getAddPrimaryKeySQL, getAlterSequenceSQL, getArray, getAsciiStream, getBatchFetchSize, getBatchLimit, getBigDecimal, getBigInteger, getBinaryStream, getBlob, getBlobObject, getBoolean, getBooleanRepresentation, getByte, getBytes, getCalendar, getCastFunction, getCastFunction, getCatalogNameForMetadata, getCatalogNameForMetadata, getChar, getCharacterStream, getClob, 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, getGeneratedKeySequenceName, getGenKeySeqName, getIdentifierConcatenator, getIdentifierDelimiter, getIdentifierRule, getIdentifierRules, getIdentityColumnName, getImportedKeys, getImportedKeys, getInt, getInvalidColumnWordSet, getJDBCType, getJDBCType, getKey, getLeadingDelimiter, getLOBStream, getLocale, getLog, getLong, getMajorVersion, getMillisecondBehavior, getMinorVersion, getNamingUtil, getNumber, getPlaceholderValueString, getPreferredType, getPrimaryKeyConstraintSQL, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaCase, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelectTableAliases, getSequence, getSequences, getSequences, getShort, getStoredProcedure, getString, getSupportsDelimitedIdentifiers, getSupportsXMLColumn, getTableNameForMetadata, getTableNameForMetadata, getTables, getTables, getTime, 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, insertSize, isSelect, isSystemIndex, isSystemIndex, isSystemSequence, isSystemTable, isSystemTable, isUsingLimit, isUsingOffset, isUsingOrderBy, isUsingRange, makeNameValid, makeNameValid, makeNameValid, makeNameValid, matchErrorState, mathFunction, needsToCreateIndex, needsToCreateIndex, newColumn, newForeignKey, newIndex, newPrimaryKey, newSequence, newStoreException, newTable, prepareStatement, refSchemaComponents, serialize, setArray, setAsciiStream, setBatchLimit, setBigDecimal, setBigInteger, setBlob, setBlobObject, setBoolean, setBooleanRepresentation, setByte, setBytes, setCalendar, setChar, setCharacterStream, setClob, setConfiguration, setDate, setDate, setDateMillisecondBehavior, setDefaultSchemaName, setDelimitedCase, setDelimitIdentifiers, setDouble, setFloat, setInt, setJoinSyntax, setLeadingDelimiter, setLocale, setLong, setMajorVersion, setMinorVersion, setNumber, setObject, setQueryTimeout, setRef, setShort, setStatementQueryTimeout, setSupportsDelimitedIdentifiers, setSupportsXMLColumn, setTime, setTimeouts, setTimeouts, setTimestamp, setTrailingDelimiter, setTrimSchemaName, setTyped, setUnknown, setUnknown, setXMLTypeEncoding, shorten, startConfiguration, storageWarning, substring, supportsDeferredForeignKeyConstraints, supportsDeferredUniqueConstraints, supportsDeleteAction, supportsIsolationForUpdate, supportsRandomAccessResultSet, supportsUpdateAction, toBulkOperation, toDBName, toDBName, toDelete, toOperation, toOperation, toSelect, toSelect, toSelect, toSelectCount, toSQL92Join, toTraditionalJoin, toUpdate, updateBlob, updateClob, validateBatchProcess, validateDBSpecificBatchProcess, versionEqualOrEarlierThan, versionEqualOrLaterThan, versionLaterThan

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

Field Detail
- SELECT_HINT
```
public static final String SELECT_HINT
```
  See Also:
  
  Constant Field Values
- VENDOR_ORACLE
```
public static final String VENDOR_ORACLE
```
  See Also:
  
  Constant Field Values
- useTriggersForAutoAssign
```
public boolean useTriggersForAutoAssign
```
  If true, then simulate auto-assigned values in Oracle by using a trigger that inserts a sequence value into the primary key value when a row is inserted.
- autoAssignSequenceName
```
public String autoAssignSequenceName
```
  The global sequence name to use for autoassign simulation.
- openjpa3GeneratedKeyNames
```
public boolean openjpa3GeneratedKeyNames
```
  Flag to use OpenJPA 0.3 style naming for auto assign sequence name and trigger name for backwards compatibility.
- useSetFormOfUseForUnicode
```
public boolean useSetFormOfUseForUnicode
```
  If true, then OpenJPA will attempt to use the special OraclePreparedStatement.setFormOfUse method to configure statements that it detects are operating on unicode fields.
- supportsSetClob
```
@Deprecated
public boolean supportsSetClob
```
  Deprecated.
  
  This variable was used prior to 2.1.x to indicate that OpenJPA should attempt to use a Reader-based JDBC 4.0 method to set Clob or XML data. It allowed XMLType and Clob values larger than 4000 bytes to be used. For 2.1.x+, code was added to allow said functionality by default (see OPENJPA-1691). For forward compatibility, this variable should not be removed.
- xmlTypeMarker
```
public String xmlTypeMarker
```
  Type constructor for XML column, used in INSERT and UPDATE statements.

Constructor Detail
- OracleDictionary
```
public OracleDictionary()
```

Method Detail

endConfiguration
```
public void endConfiguration()
```
Description copied from interface: Configurable

Invoked upon completion of bean property configuration for this object.

Specified by:

endConfiguration in interface Configurable

Overrides:

endConfiguration in class DBDictionary

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:

connectedConfiguration in class DBDictionary

Throws:

SQLException

ensureDriverVendor
```
public void ensureDriverVendor()
```
Ensure that the driver vendor has been set, and if not, set it now.

supportsLocking
```
public boolean supportsLocking(Select sel)
```
Description copied from class: DBDictionary

Returns true if a "FOR UPDATE" clause can be used for the specified Select object.

Overrides:

supportsLocking in class DBDictionary

getSelects
```
protected SQLBuffer getSelects(Select sel,
                               boolean distinctIdentifiers,
                               boolean forUpdate)
```
Description copied from class: DBDictionary

Return the portion of the select statement between the SELECT keyword and the FROM keyword.

Overrides:

getSelects in class DBDictionary

canOuterJoin
```
public boolean canOuterJoin(int syntax,
                            ForeignKey fk)
```
Description copied from class: DBDictionary

Returns if the given foreign key can be eagerly loaded using other joins.

Overrides:

canOuterJoin in class DBDictionary

toNativeJoin
```
public SQLBuffer toNativeJoin(Join join)
```
Description copied from class: DBDictionary

Use the given join instance to create SQL joining its tables in the database's native syntax. Throws an exception by default.

Overrides:

toNativeJoin in class DBDictionary