com.sibvisions.rad.persist.jdbc
Class AbstractOracleDBAccess

java.lang.Object
  com.sibvisions.rad.persist.jdbc.DBAccess
      com.sibvisions.rad.persist.jdbc.AbstractOracleDBAccess

All Implemented Interfaces:

IDBAccess, ICloseable

Direct Known Subclasses:

OracleDBAccess, TiberoDBAccess

public abstract class AbstractOracleDBAccess
extends DBAccess

The AbstractOracleDBAccess is the base implementation for Oracle databases.

See Also:

DBAccess

Nested Class Summary

Nested classes/interfaces inherited from class com.sibvisions.rad.persist.jdbc.DBAccess

DBAccess.BlobFileHandle, DBAccess.ParameterizedStatement

Field Summary

protected List<ForeignKey>	cachedForeignKeys The cached foreign key.
protected Hashtable<String,List<String>>	cachedFoundValues The cached check constraints.
protected String	cachedKeyIdentifier The cached table identifier.
protected Key	cachedPrimaryKey The cached primary key.
protected String	cachedReason The cached table identifier.
protected List<Key>	cachedUniqueKeys The cached unique key.

Fields inherited from class com.sibvisions.rad.persist.jdbc.DBAccess

ALLOWED_VALUES_NULL, BFILE, cachedCatalogInfo, cachedColumnMetaData, cachedMetaDataIdentifier, cachedSchemaInfo, COLUMNMETADATA_NULL, currentSavepoint, DEFAULT_VALUES_NULL, FKS_NULL, LONGNVARCHAR, NCHAR, NCLOB, NVARCHAR, PKS_NULL, QUOTE, SQLXML, TABLEINFO_NULL, TABLENAME_NULL, TIMESTAMPWITHLOCALTIMEZONE, TIMESTAMPWITHTIMEZONE, UKS_NULL

Constructor Summary

AbstractOracleDBAccess()

Method Summary

protected abstract Object	convertArrayToList(Object pParam) Converts arrays to List of IBean.
protected abstract Object	convertToArray(AbstractParam pParam) Converts list or array to oracle arrays.
protected boolean	detectModified() Detects if a transaction is open directly in the database.
Object	executeFunction(String pFunctionName, OutParam pReturnOutParam, Object... pParameters) Executes a DB function with the specified parameters and return the result.
void	executeProcedure(String pProcedureName, Object... pParameters) Executes a DB procedure with the specified parameters.
protected Map<String,Object[]>	getAllowedValuesIntern(String pCatalog, String pSchema, String pTable) Gets the allowed values from a specific table.
protected void	getAndStoreKeysIntern(String pCatalog, String pSchema, String pTable, String pReason) Gets all constraints at once, as it is faster in Oracle.
Connection	getConnection() Returns the connection to the database.
String	getDatabaseSpecificLockStatement(String pWritebackTable, ServerMetaData pServerMetaData, ICondition pPKFilter) Returns the database specific statement to lock the specified row in the database.
protected Map<String,Object>	getDefaultValuesIntern(String pCatalog, String pSchema, String pTable) Gets all default column values of a specific table.
protected List<ForeignKey>	getForeignKeysIntern(String pCatalog, String pSchema, String pTable) Returns all Foreign Keys for the specified table.
protected Key	getPrimaryKeyIntern(String pCatalog, String pSchema, String pTable) It's gets all Primary Key columns and return it as String[].
protected String	getTableForSynonymIntern(String pStatement, String pSynomyn) Gets the table name for a synonym.
protected TableInfo	getTableInfoIntern(String pWriteBackTable) Returns the meta data information for the specified query, and configures all columns with defaults.
protected List<Key>	getUniqueKeysIntern(String pCatalog, String pSchema, String pTable) It gets all columns for each Unique Key and return it.
Object[]	insertDatabaseSpecific(String pWriteBackTable, String pInsertStatement, ServerMetaData pServerMetaData, Object[] pNewDataRow, String pDummyColumn) Returns the newly inserted row from a Database specific insert statement.
protected Object[]	insertOracle(String pTablename, String pInsertStatement, ServerMetaData pServerMetaData, Object[] pNewDataRow, String pDummyColumn) Returns the newly inserted row from an Oracle Database.
void	open() It opens the database and stores the Connection object.

Methods inherited from class com.sibvisions.rad.persist.jdbc.DBAccess

clearMetaData, clearMetaData, close, commit, commitOrRollbackBeforeClose, convertDatabaseSpecificObjectToValue, convertValueToDatabaseSpecificObject, createIdentifier, createReplace, createServerColumnMetaData, createWhereColumn, createWhereParam, debug, delete, error, eventClearedMetaData, eventClosedDBAccess, eventConfigureConnection, eventOpenedDBAccess, eventUnconfigureConnection, executeFunction, executeInsertStatement, executeQuery, executeSql, executeSqlMulti, executeStatement, fetch, fetch, fetch, fetch, fillResultSetIntoListOfBean, findAndCreateReducedCondition, findNamedParameters, fireEventAfterOpenDBAccess, fireEventBeforeCloseDBAccess, fireEventClearedMetaData, fireEventConfigureConnection, fireEventUnconfigureConnection, formatSQLException, formatSQLException, getAllowedValues, getAllowedValuesCache, getAndStoreMetaDataIntern, getApplicationName, getAutomaticLinkColumnNameTranslation, getCloseQuoteCharacter, getColumnMetaData, getColumnMetaDataCache, getColumnMetaDataCreator, getColumnMetaDataIntern, getColumnName, getConnectionIntern, getConnectionPool, getDBAccess, getDBAccess, getDBAccess, getDBAccess, getDBAccess, getDBAccessByIdentifier, getDBProperties, getDBProperty, getDefaultAllowedValues, getDefaultCursorCacheTimeout, getDefaultLargeObjectLimit, getDefaultSchema, getDefaultValues, getDefaultValuesCache, getDiscardRowCount, getDriver, getForeignKeyCache, getForeignKeys, getIdentifier, getLargeObjectLimit, getMaxColumnLength, getMaxTime, getMetaDataCacheOption, getMetaDataWhereClause, getObjectFromResultSet, getObjectFromResultSet, getOpenQuoteCharacter, getParameter, getParameter, getParameterizedSelectStatement, getPassword, getPreparedStatement, getPreparedStatement, getPrimaryKey, getPrimaryKeyCache, getQueryTimeout, getRealQueryColumnName, getSelectStatement, getSelectStatement, getSQL, getTableForSynonym, getTableForSynonymIntern, getTableInfo, getTableInfoCache, getTableNameCache, getTransactionTimeout, getUniqueKeyCache, getUniqueKeys, getUrl, getUsername, getWhereClause, info, initializeColumnMetaData, initializeDataType, initializeServerColumnMetaData, insert, insertAnsiSQL, isAutoCommit, isAutoQuote, isConnectionPoolEnabled, isJdbc, isLogEnabled, isMetaDataCacheEnabled, isModified, isOpen, isReleaseConnectionPending, isTypeEqual, isUseSavepoints, lockRow, lockRowInternal, prepareConnection, quote, quoteAllways, registerDBAccessClass, releaseConnection, releaseConnectionIntern, releaseSavepoint, removeDBSpecificQuotes, removeQuotes, rollback, rollbackToSavepoint, setAllowedValuesCache, setAutoCommit, setAutomaticLinkColumnNameTranslation, setColumnMetaDataCache, setColumnMetaDataCreator, setColumnMetaDataCreator, setColumnsToStore, setConnection, setConnectionPool, setConnectionPoolEnabled, setDBProperties, setDBProperty, setDefaultCursorCacheTimeout, setDefaultLargeObjectLimit, setDefaultSchema, setDefaultValuesCache, setDriver, setForeignKeyCache, setLargeObjectLimit, setMaxTime, setMetaDataCacheOption, setModified, setPassword, setPrimaryKeyCache, setQueryTimeout, setQuoteCharacters, setSavepoint, setTableInfoCache, setTableNameCache, setTransactionTimeout, setUniqueKeyCache, setUrl, setUsername, setUseSavepoints, splitSchemaTable, supportsGetGeneratedKeys, toString, translateDefaultValue, translateQuotes, translateValue, update, updateAnsiSQL, updateDatabaseSpecific

Methods inherited from class java.lang.Object

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

Field Detail

cachedKeyIdentifier

protected String cachedKeyIdentifier

The cached table identifier.

cachedReason

protected String cachedReason

The cached table identifier.

cachedPrimaryKey

protected Key cachedPrimaryKey

The cached primary key.

cachedUniqueKeys

protected List<Key> cachedUniqueKeys

The cached unique key.

cachedForeignKeys

protected List<ForeignKey> cachedForeignKeys

The cached foreign key.

cachedFoundValues

protected Hashtable<String,List<String>> cachedFoundValues

The cached check constraints.

Constructor Detail

AbstractOracleDBAccess

public AbstractOracleDBAccess()

Method Detail

convertArrayToList

protected abstract Object convertArrayToList(Object pParam)
                                      throws SQLException

Converts arrays to List of IBean.

Parameters:

pParam - the param to check

Returns:

the param or a list in case of array.

Throws:

SQLException - the exception

convertToArray

protected abstract Object convertToArray(AbstractParam pParam)
                                  throws SQLException

Converts list or array to oracle arrays.

Parameters:

pParam - the param to check

Returns:

the param or a list in case of array.

Throws:

SQLException - the exception

getDatabaseSpecificLockStatement

public String getDatabaseSpecificLockStatement(String pWritebackTable,
                                               ServerMetaData pServerMetaData,
                                               ICondition pPKFilter)
                                        throws DataSourceException

Returns the database specific statement to lock the specified row in the database.

Overrides:

getDatabaseSpecificLockStatement in class DBAccess

Parameters:

pWritebackTable - the table to use.

pServerMetaData - the MetaDataColumn array to use.

pPKFilter - the PK filter with the values to use.

Returns:

the database specific statement to lock the specified row in the database.

Throws:

DataSourceException - if some parts are missing for the statement

insertDatabaseSpecific

public Object[] insertDatabaseSpecific(String pWriteBackTable,
                                       String pInsertStatement,
                                       ServerMetaData pServerMetaData,
                                       Object[] pNewDataRow,
                                       String pDummyColumn)
                                throws DataSourceException

Returns the newly inserted row from a Database specific insert statement.
Database specific derivations of DBAccess need to implement it database specific.

Overrides:

insertDatabaseSpecific in class DBAccess

Parameters:

pWriteBackTable - the table to use for the insert

pInsertStatement - the SQL Statement to use for the insert

pServerMetaData - the meta data to use.

pNewDataRow - the new row (Object[]) with the values to insert

pDummyColumn - null, if all writeable columns are null, but for a correct INSERT it have to be minimum one column to use in the syntax.

Returns:

the newly inserted row from an Oracle Database.

Throws:

DataSourceException - if an Exception occur during insert to the storage

open

public void open()
          throws DataSourceException

It opens the database and stores the Connection object.

Overrides:

open in class DBAccess

Throws:

DataSourceException - if the database couldn't opened

getConnection

public Connection getConnection()
                         throws SQLException

Returns the connection to the database.

Overrides:

getConnection in class DBAccess

Returns:

the connection to the database.

Throws:

SQLException - if connection is not available.

getAndStoreKeysIntern

protected void getAndStoreKeysIntern(String pCatalog,
                                     String pSchema,
                                     String pTable,
                                     String pReason)
                              throws DataSourceException

Gets all constraints at once, as it is faster in Oracle.

Parameters:

pCatalog - the catalog

pSchema - the schema

pTable - the table

pReason - the reason

Throws:

DataSourceException - the exception

getUniqueKeysIntern

protected List<Key> getUniqueKeysIntern(String pCatalog,
                                        String pSchema,
                                        String pTable)
                                 throws DataSourceException

It gets all columns for each Unique Key and return it.

Overrides:

getUniqueKeysIntern in class DBAccess

Parameters:

pCatalog - the catalog to use

pSchema - the schema to use

pTable - the table to use

Returns:

all columns for each Unique Key.

Throws:

DataSourceException - if an error occur during UK search process.

getPrimaryKeyIntern

protected Key getPrimaryKeyIntern(String pCatalog,
                                  String pSchema,
                                  String pTable)
                           throws DataSourceException

It's gets all Primary Key columns and return it as String[]. Gets all Primary Key columns and return it as list of Strings.

Overrides:

getPrimaryKeyIntern in class DBAccess

Parameters:

pCatalog - the catalog to use

pSchema - the schema to use

pTable - the table to use

Returns:

all Primary Key columns and return it as String[].

Throws:

DataSourceException - if an error occur during PK search process.

getForeignKeysIntern

protected List<ForeignKey> getForeignKeysIntern(String pCatalog,
                                                String pSchema,
                                                String pTable)
                                         throws DataSourceException

Returns all Foreign Keys for the specified table.

Overrides:

getForeignKeysIntern in class DBAccess

Parameters:

pCatalog - the catalog to use

pSchema - the schema to use

pTable - the table to use as base table.

Returns:

all Foreign Keys for the specified table.

Throws:

DataSourceException - if an error occur in determining the ForeignKeys.

getDefaultValuesIntern

protected Map<String,Object> getDefaultValuesIntern(String pCatalog,
                                                    String pSchema,
                                                    String pTable)
                                             throws DataSourceException

Gets all default column values of a specific table.

Overrides:

getDefaultValuesIntern in class DBAccess

Parameters:

pCatalog - the catalog name

pSchema - the schema name

pTable - the table name

Returns:

a Hashtable with the column name as key and the default value as value. It only contains columns with a default value

Throws:

DataSourceException - if the database access throws an exception

getAllowedValuesIntern

protected Map<String,Object[]> getAllowedValuesIntern(String pCatalog,
                                                      String pSchema,
                                                      String pTable)
                                               throws DataSourceException

Gets the allowed values from a specific table. The allowed values are defined through check constraints or other table related restrictions.

Overrides:

getAllowedValuesIntern in class DBAccess

Parameters:

pCatalog - the catalog name

pSchema - the schema name

pTable - the table to check

Returns:

a Hashtable with a column name as key and the allowed values as array of Objects or null if there are no allowed values

Throws:

DataSourceException - if the database access throws an exception

getTableInfoIntern

protected TableInfo getTableInfoIntern(String pWriteBackTable)
                                throws DataSourceException

Returns the meta data information for the specified query, and configures all columns with defaults.

Overrides:

getTableInfoIntern in class DBAccess

Parameters:

pWriteBackTable - the write back table to use for the isWriteable() state (Optional)

Returns:

the meta data for the specified query, and initials all columns.

Throws:

DataSourceException - if an Exception occur during getting the meta data or if the storage is not opened or if one columns SQL type is not supported

detectModified

protected boolean detectModified()

Detects if a transaction is open directly in the database.

Overrides:

detectModified in class DBAccess

Returns:

true, if a transaction is open directly in the database.

executeFunction

public Object executeFunction(String pFunctionName,
                              OutParam pReturnOutParam,
                              Object... pParameters)
                       throws SQLException

Executes a DB function with the specified parameters and return the result.

Overrides:

executeFunction in class DBAccess

Parameters:

pFunctionName - the function (optional with package) name.

pReturnOutParam - the return SQL Type (see Types

pParameters - the parameters to use with the correct and corresponding java type.

Returns:

the result of the DB function call.

Throws:

SQLException - if the call failed.

executeProcedure

public void executeProcedure(String pProcedureName,
                             Object... pParameters)
                      throws SQLException

Executes a DB procedure with the specified parameters.

Overrides:

executeProcedure in class DBAccess

Parameters:

pProcedureName - the procedure (optional with package) name.

pParameters - the parameters to use with the correct and corresponding java type.

Throws:

SQLException - if the call failed.

insertOracle

protected Object[] insertOracle(String pTablename,
                                String pInsertStatement,
                                ServerMetaData pServerMetaData,
                                Object[] pNewDataRow,
                                String pDummyColumn)
                         throws DataSourceException

Returns the newly inserted row from an Oracle Database.
It uses RETURNING .. INTO to get the primary key values back from the database.

Parameters:

pTablename - the table to use for the insert

pInsertStatement - the SQL Statement to use for the insert

pServerMetaData - the meta data to use.

pNewDataRow - the new IDataRow with the values to insert

pDummyColumn - true, if all writeable columns are null, but for a correct INSERT it have to be minimum one column to use in the syntax.

Returns:

the newly inserted row from an Oracle Database.

Throws:

DataSourceException - if an Exception occur during insert the IDataRow to the storage

getTableForSynonymIntern

protected String getTableForSynonymIntern(String pStatement,
                                          String pSynomyn)
                                   throws DataSourceException

Gets the table name for a synonym.

Parameters:

pStatement - the synonym metadata statement

pSynomyn - the name of the synonym

Returns:

the name of the table or the pSynonym name if no synonym was found

Throws:

DataSourceException - if synonym detection failed