|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.jbo.common.CommonCriteriaAdapter
oracle.jbo.server.CriteriaAdapterImpl
oracle.jbo.server.BaseSQLBuilderImpl
public abstract class BaseSQLBuilderImpl
Internal: Applications should not use this interface.
Note: This interface is subject to change.
This interface is used by View Objects to construct SQL statements that create, retrieve, update and delete table rows based on the state of the cache.
Field Summary |
---|
Fields inherited from interface oracle.jbo.server.SQLBuilder |
---|
BINDING_STYLE_JDBC, BINDING_STYLE_ORACLE, BINDING_STYLE_ORACLE_NAME, BINDING_STYLE_UNKNOWN, DML_DELETE, DML_INSERT, DML_UPDATE, MAX_COLUMN_IDENTIFIER_LEN, RANGE_PAGE_BIND_HIGH_ROWNUM, RANGE_PAGE_BIND_LOW_ROWNUM |
Constructor Summary | |
---|---|
BaseSQLBuilderImpl()
|
Method Summary | |
---|---|
static void |
baseBuildSelectList(java.lang.StringBuffer buffer,
AttributeDefImpl[] attrs,
java.lang.String sourceName,
boolean forViewObject)
Creates a list of columns to be selected skipping the persistent and derived attributes. |
int |
bindDeleteStatement(EntityImpl entityContext,
java.sql.PreparedStatement stmt)
Binds the values in the entity attribute storage with the DELETE statement. |
void |
bindEffDtDateDayAddStatement(java.sql.PreparedStatement stmt,
java.lang.Object date,
int days)
Bind the statement with the values required to compute a date that is 'x' number of days apart from the specified date |
int |
bindInsertStatement(EntityImpl entityContext,
java.sql.PreparedStatement stmt,
AttributeDefImpl[] cols,
AttributeDefImpl[] retrCols,
AttributeDefImpl[] retrKeyCols,
java.util.HashMap retrList,
boolean batchMode)
Binds the entity attribute storage with the parameters in the INSERT statement. |
int |
bindOptUpdateWhereClause(EntityImpl entityContext,
java.sql.PreparedStatement stmt,
int bindIndex)
This method binds the unfetched attributes or a changed attribute of an entity definition. |
void |
bindParametersForStmt(int bindingStyle,
java.lang.Object[] params,
java.sql.PreparedStatement stmt)
Bind parameter values for a SQL execution. |
protected int |
bindParamValue(int bindingStyle,
java.lang.Object value,
DBTransactionImpl trans,
java.sql.PreparedStatement stmt,
AttributeDefImpl attrDef,
int bindIndex,
boolean skipNull)
Binds a parameter value to the Statement's bind index dealing with Null values appropriately. |
void |
bindRangePagingParams(java.sql.PreparedStatement stmt,
ViewObjectImpl vo,
int nextParamIndex,
int rangeStart,
int rangeSize)
|
int |
bindUpdateStatement(EntityImpl entityContext,
java.sql.PreparedStatement stmt,
AttributeDefImpl[] cols,
AttributeDefImpl[] retrCols,
AttributeDefImpl[] retrKeyCols,
java.util.HashMap retrList,
boolean batchMode)
Binds the entity attribute storage with the parameters in the UPDATE statement. |
protected int |
bindWhereAttrValue(EntityImpl entityContext,
DBTransactionImpl trans,
java.sql.PreparedStatement stmt,
AttributeDefImpl attrDef,
int bindIndex,
boolean skipNull)
Binds an attribute value to the Statement's WHERE clause parameter index dealing with Null values appropriately. |
int |
bindWhereClause(EntityImpl entityContext,
java.sql.PreparedStatement stmt,
AttributeDefImpl[] keyCols,
java.lang.Object rowid,
int bindIndex)
Bind the Primary key values for the designated Statement. |
int |
bindWhereClause(EntityImpl entityContext,
java.sql.PreparedStatement stmt,
java.lang.Object rowid,
int bindIndex)
Bind the Primary key values for the designated Statement. |
void |
buildDefaultViewObjectFromClause(java.lang.StringBuffer fromClause,
java.util.List eRefs)
This method is used to generate the "from" clause |
void |
buildDefaultViewObjectFromClause(java.lang.StringBuffer fromClause,
java.util.List eRefs,
BaseViewCriteriaManagerImpl vcManager)
This method is used to generate the "from" clause if the following conditions are met: The View Object definition does not have an expert mode query The View Object definition is set to generate "from" clause during runtime, either in metadata or by calling ViewDefImpl.setFromClauseFlags(ViewDefImpl.CLAUSE_GENERATE_RT)
|
java.util.HashMap |
buildDefaultViewObjectWhereClause(java.lang.StringBuffer whereClause,
java.util.List eRefs,
java.util.List forcedERefs,
EntityReference[][] newEntRefsArr,
boolean isInlineViewForFroms)
This method is used to generate the "where" clause if the following conditions are met: The View Object definition does not specify "where" clause The View Object definition is set to generate "where" clause during runtime, either in metadata or by calling ViewDefImpl.setWhereClauseFlags(ViewDefImpl.CLAUSE_GENERATE_RT)
|
java.lang.StringBuffer |
buildDeleteStatement(EntityImpl entityContext)
Build a DELETE SQL for the Entity Object. |
java.lang.String |
buildEffDtDateDayAddStatement()
Returns a statement that returns a date that is 'x' number of days apart from the specified date. |
java.lang.StringBuffer |
buildInsertStatement(EntityImpl entityContext,
AttributeDefImpl[] cols,
AttributeDefImpl[] retrCols,
AttributeDefImpl[] retrKeyCols,
boolean batchMode)
Build a INSERT SQL for the Entity Object skipping non-persistent values. |
void |
buildOptUpdateWhereClause(EntityImpl entityContext,
java.lang.StringBuffer buffer,
AttributeDefImpl[] cols)
This method binds the unfetched attributes in the list or the change indicator column of an entity definition. |
java.lang.String |
buildRangePagingQuery(ViewObjectImpl vo,
java.lang.String qry,
int noUserParams)
|
void |
buildSelectList(java.lang.StringBuffer buffer,
AttributeDefImpl[] attrs,
java.lang.String sourceName,
boolean forViewObject)
Build a list of columns that could be used in a SELECT statement. |
void |
buildSelectString(DBTransactionImpl trans,
java.lang.StringBuffer buffer,
java.lang.String sourceName,
java.lang.String sourceAlias,
AttributeDefImpl[] attrs,
boolean withIntoClause,
int bindingStyle)
Construct a SQL SELECT statement for the Entity into the designated Buffer. |
protected void |
buildSelectString(java.lang.StringBuffer buffer,
java.lang.String sourceName,
AttributeDefImpl[] attrs,
boolean withIntoClause)
Construct a SQL SELECT statement for the Entity into the designated Buffer. |
java.lang.StringBuffer |
buildUpdateStatement(EntityImpl entityContext,
AttributeDefImpl[] cols,
AttributeDefImpl[] retrCols,
AttributeDefImpl[] retrKeyCols,
boolean batchMode)
Build a UPDATE SQL for the Entity Object skipping non-persistent values. |
void |
buildWhereClause(EntityImpl entityContext,
java.lang.StringBuffer buffer,
AttributeDefImpl[] keyCols,
java.lang.Object rowid)
Creates a WHERE clause containing the Primary Key columns passed to the method. |
protected boolean |
capabilityCanReuseLockStatements()
Check if the a cached prepared statement to lock a row can be reused for this database flavor. |
java.lang.String |
checkTableNameForQuotes(java.lang.String tableName)
Add quotes to any table name that may need it. |
boolean |
compareFetchedValue(EntityImpl entity,
AttributeDefImpl ad,
java.lang.Object cacheValue,
java.lang.Object fetchedValue)
Compare the cacheValue with fetchedValue and if they are equal return true This API is used when comparing cached entity with a faulted in entity. |
boolean |
containsTableAlias(java.lang.String clause,
java.lang.String alias)
|
protected java.lang.String[] |
convertFlags(boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap)
|
java.lang.Object |
convertValueToStorageType(java.lang.Object value)
This method is used to convert the Java type to a JDBC type so that it could be used to bind as a parameter for SQL execution. |
protected java.lang.Object |
convertValueToWhereFragment(ViewCriteriaItem curDef,
java.lang.String trimmedValue)
Converts a literal value to be used in the WHERE clause. |
protected java.lang.Object |
convertValueToWhereFragment(ViewObject vo,
ViewCriteria vc,
ViewCriteriaItem curDef,
java.lang.String trimmedValue)
Converts a literal value to be used in the WHERE clause. |
protected LongRunningStatementHandle |
createHandleForCancellableStatements(DBTransactionImpl trans,
java.sql.Statement stmt)
Creates a handle that could be used later to terminate a long running statment. |
void |
doEntityDML(EntityImpl entityContext,
int operation,
TransactionEvent e)
Performs the appropriate SQL Data Manipulation Language (DML) operations on the database to reflect an update, delete or insert operation on an Entity Object. |
void |
doEntitySelect(EntityImpl entityContext,
boolean lock)
Perform the appropriate SQL operations to execute a select operation on an Entity Object. |
void |
doEntitySelectForAltKey(EntityImpl entityContext,
int keyIndex,
boolean lock)
|
java.lang.Object[] |
doLoadBulkFromResultSet(AttributeDefImpl[] attrDefs,
int attrIndex,
java.sql.ResultSet rs,
int index,
DBTransactionImpl trans)
Loads an array of objects from a result set. |
java.lang.Object |
doLoadFromResultSet(java.lang.Object theTypeFactory,
java.lang.Object theElemFactory,
java.lang.Class theJavaType,
byte attrLoad,
java.sql.ResultSet rs,
int index,
DBTransactionImpl trans)
Loads an object from a result set. |
java.lang.Object |
doLoadFromStatement(java.lang.Object theTypeFactory,
java.lang.Object theElemFactory,
java.lang.Class theJavaType,
java.sql.PreparedStatement ps,
int index,
Transaction trans)
Loads an object from a result set. |
void |
doPreparedStatementDefineColumnType(java.sql.PreparedStatement ps,
int colnum,
int sqltype)
Performs the equivalent of defineColumnType() on a prepared statement. |
void |
doPreparedStatementDefines(java.sql.PreparedStatement ps,
AttributeDefImpl[] attrs)
Defines the column types of the attributes based on the meta-data. |
void |
doRefreshSQL(EntityImpl entityContext,
int operation,
AttributeDefImpl[] columns,
AttributeDefImpl[] retrKeyCols)
Refreshes the entity after an update on the database. |
void |
doRegisterDefaultDriver(java.lang.String url)
Registers the JDBC driver associated with this type of JDBC connection. |
void |
doStatementSetBindingStyle(java.sql.Statement ps,
int bindingStyle)
Sets the binding style for the statement. |
void |
doStatementSetBindingStyleDefault(java.sql.Statement ps)
Sets the binding style to the default value of the database type. |
void |
doStatementSetRowPrefetch(java.sql.Statement ps,
int prefetchSize)
Performs the equivalent of setRowPrefetch() on a statement. |
protected static void |
dumpConstraint(java.lang.Object[] constraintEntry)
debug method to be called by all implementors of getConstraints - provides formatted output of the complex constraint struct. |
void |
executeBatch(java.sql.PreparedStatement stmt)
Executes the PreparedStatement in batch mode. |
int |
findTableAliasInSQLExpr(java.lang.String clause,
java.lang.String alias,
int start)
|
java.lang.Object |
generatePKBasedRef(EntityImpl entityContext)
Generates a PK-Based REF for an Entity Object. |
java.lang.Object[] |
generateRefAndOID(EntityImpl entityContext)
Generates an object Ref and OID for an Entity Object. |
java.lang.Object |
generateRowID(EntityImpl entityContext)
Get the ROWID attribute. |
java.lang.String |
getBaseTable(java.sql.Connection conn,
java.lang.String schema,
java.lang.String name)
Unroll any synonyms that may be present, and get the real objectname. |
static int |
getBindingStyleValue(java.lang.String bindingStyleStr)
|
java.lang.String |
getCappedQueryHitCountSQL(RowSet rs,
long cap)
|
protected java.lang.String |
getColumnNameWithFormatForQuery(java.lang.String lhspart,
AttributeDef attrDef,
int sqltype)
Deprecated. since 9.0.3 |
java.util.Vector |
getConstraints(java.sql.Connection conn,
java.lang.String catalog,
java.lang.String schema,
java.lang.String table)
Return vector with constraint details for this table. |
java.util.ArrayList |
getConstraintsList(java.sql.Connection conn,
java.lang.String catalog,
java.lang.String user_or_schema,
java.lang.String full_tablename)
Return vector with constraint details for this table where each detail is in a String array with this structure: 0 String owner |
abstract java.lang.String |
getCreateSequenceInsertTriggerSQL(java.lang.String triggerName,
java.lang.String tableName,
java.util.ArrayList sequenceNames,
java.util.ArrayList colNames)
Returns a SQL statement that creates a trigger that updates a column with the value from a sequence upon the creation of a new row. |
abstract java.lang.String |
getCreateSequenceSQL(java.lang.String sequenceName,
int startVal)
Returns a SQL statement that creates a Sequence with an initial value specified in the argument. |
java.sql.Timestamp |
getCurrentDbTime(java.sql.Connection conn)
Returns the current time from the Database. |
java.util.ArrayList |
getDBOperationList(java.sql.Connection connection,
java.lang.String userName,
java.lang.String packageFilter,
java.lang.String operationFilter)
Return a list of packages visible in this connection. |
java.util.ArrayList |
getDBPackageList(java.sql.Connection connection,
java.lang.String userName,
java.lang.String packageFilter)
Return a list of packages visible in this connection. |
abstract java.lang.String |
getDbTimeQuery()
Returns a SQL statement to obtain the current time from the database. |
abstract java.lang.String |
getDbType()
Returns a string uniquely identifying this type of SQLBuilder. |
int |
getDefaultBindingStyle()
Unless overridden, the binding style is set to JDBC (Oracle versions change this). |
abstract java.lang.String |
getDropSequenceSQL(java.lang.String sequenceName)
Returns a SQL statement that drops a specified Sequence. |
abstract java.lang.String |
getDropTableSQL(java.lang.String dbObjectName)
Returns a SQL statement that drops a specified table. |
java.lang.String |
getFormattedLHSCompareFragment(ViewObject vo,
ViewCriteria vc,
AttributeDef attrDef,
int sqlType,
java.lang.String lhs,
java.lang.Object rhs)
This method provides a formatted left-hand-comparator fragment of a comparision in a where clause for the given column. |
protected java.lang.String |
getFormattedRHSCompareFragment(AttributeDef attrDef,
int sqlType,
java.lang.String rhs)
Override this method to provide a formatted right-hand-comparator fragment of a comparision in a where clause for the given column. |
java.lang.String |
getFormattedRHSCompareFragment(ViewObject vo,
ViewCriteria vc,
AttributeDef attrDef,
int sqlType,
java.lang.String rhs)
Override this method to provide a formatted right-hand-comparator fragment of a comparision in a where clause for the given column. |
protected abstract java.lang.String |
getJDBCDriverClassName(java.lang.String url)
Concrete implementations of SQLBuilder must elect a default driver name. |
protected boolean |
getLockTrailerIsAtEnd()
For some databases like SQLServer that row lock clause is placed before the WHERE clause while for some other databases like Oracle it is at the end of SQL Statement. |
int |
getMaxTableNameLength(java.sql.Connection conn)
Return the maximum length of a table name for the Database connection. |
java.util.ArrayList |
getNestedTables(java.sql.Connection conn)
Returns a list of nested tables in this connection. |
abstract java.lang.String |
getPersistManagerClassName()
Returns the name of default PersistManager class name. |
java.lang.String |
getQueryHitCountSQL(RowSet rs)
Returns a SQL statement to estimate the number of rows effected by the query using the rowset values. |
protected java.lang.String |
getQuotationMarkLeft()
Left half of string used to quote database identifiers. |
protected java.lang.String |
getQuotationMarkRight()
Right half of string used to quote database identifiers. |
protected java.lang.Object |
getROWID(EntityImpl entityContext)
Get the ROWID attribute. |
java.util.Vector |
getSchemaList(java.sql.Connection conn)
Return a list of schemas for this database (note that for Oracle this is synonymous with users) |
java.util.ArrayList |
getSchemas(java.sql.Connection conn)
Return a list of schemas for this database (note that for Oracle this is synonymous with users) |
protected java.lang.String |
getSqlVariantLockTrailer()
This defines the string that will be post-fixed to SQL statements to have the rows locked - if the DB is incapable of this then it should return null. |
java.lang.String |
getStringConcatOper(boolean bIncludeSpaces)
Returns a String concatenation operator for query clause generation. |
protected boolean |
getSupportsAliasInUpdateStatements()
Assume that aliases are permitted, unless a builder denies it |
java.util.Vector |
getTableList(java.sql.Connection conn,
java.lang.String defaultUserName,
java.lang.String userName,
boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap)
Return a list of tables visible in this connection. |
java.util.Vector |
getTableList(java.sql.Connection conn,
java.lang.String defaultUserName,
java.lang.String userName,
boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap,
boolean bIncludeNested)
Return a list of tables visible in this connection. |
java.util.ArrayList |
getTables(java.sql.Connection conn,
java.lang.String defaultUserName,
java.lang.String userName,
boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap)
Return a list of tables visible in this connection. |
java.util.ArrayList |
getTables(java.sql.Connection conn,
java.lang.String defaultUserName,
java.lang.String userName,
boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap,
boolean bIncludeNested)
Return a list of tables visible in this connection. |
java.util.ArrayList |
getTables(java.sql.Connection conn,
java.lang.String defaultUserName,
java.lang.String userName,
java.lang.String nameFilter,
boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap)
Return a list of tables visible in this connection. |
java.util.ArrayList |
getTables(java.sql.Connection conn,
java.lang.String defaultUserName,
java.lang.String userName,
java.lang.String nameFilter,
boolean bTable,
boolean bAlias,
boolean bView,
boolean bSnap,
boolean bIncludeNested)
Return a list of tables visible in this connection. |
abstract java.lang.String |
getTypeMapName()
Returns a String identifying the preferred type map to use. |
abstract java.lang.String |
getVersion()
Gets a string describing the version of this implentation of this interface. |
ViewCriteriaAdapter |
getViewCriteriaAdapter()
Returns a ViewCriteriaAdapter for the SQLBuilder object. |
protected java.lang.String |
getWarningText(java.lang.String message)
For use withinn DebugDiagnostic messages. |
boolean |
invalidDatumFactoryUsage(java.lang.String colType,
int id,
java.lang.Class clz)
Returns false only for types where raw-bytes may be used to create the desired attribute values while fetching data from jdbc. |
boolean |
isConnectionAlive(java.sql.Connection conn)
Detects if a connection is alive. |
boolean |
isDataSourceJTABased(javax.sql.DataSource ds)
Checks if the DataSource is JTA-enabled. |
abstract boolean |
isDisplayBindValueUI()
For Oracle database the test SQL wizards provide additional functionality to bind the parameters with test values. |
boolean |
isNCharType(java.sql.Statement stmt,
int index)
Tests if the select statement at a given column index corresponds to an international character column. |
boolean |
isNewLineAllowedInSQL(java.sql.Connection conn)
Checks if the JDBC driver supports new line character in SQL statements. |
boolean |
isSQLRecoverableException(java.lang.Exception ex)
Checks if the exception is recoverable such that a retry after obtaining a new connection may succeed. |
boolean |
isStreamType(int sqlTypeId)
Check if a given type provides streaming support. |
void |
jdbcClientSideSecurity(java.util.Properties info,
java.util.Hashtable env)
Populates the properties with known security attributes found in the environment. |
javax.sql.DataSource |
lookupDataSource(java.lang.String nsUrl,
java.lang.String nsUser,
java.lang.String nsPasswd,
java.lang.String dataSourceName)
Performs a JNDI lookup for the datasource. |
protected boolean |
needsQuotedTableName(java.lang.String tableName)
Inspects the table name if it needs to be escaped with quotes. |
void |
populateCompOpers()
|
void |
populateJboTypeMapEntries()
Populates the system typemap table with entries appropriate for the JDBC implementation. |
java.lang.String |
processClauseForSubQuery(java.lang.String clause,
EntityReference[] entRefs,
java.lang.String suffix,
boolean isSQLExpr,
boolean[] isModified)
|
java.lang.String |
processClauseReplaceTableAliases(java.lang.String clause,
RowReference[] origEntRefs,
RowReference[] newEntRefs,
boolean isSQLExpr,
boolean[] isModified)
|
void |
processException(java.lang.String errorCode,
java.lang.Exception sqlEx,
java.lang.Object[] params)
Handle SQL exceptions by wrapping into SQLStmtException
or JboException . |
ADFDatabaseChangeListener |
registerDatabaseChangeListener(QueryCollection listener,
java.sql.Connection conn,
java.sql.Statement stmt)
Register a Query Collection to listen to database data change events. |
void |
releaseSavepoint(java.sql.Connection conn,
java.lang.String id)
Release SAVEPOINT if possible. |
void |
rollbackToSavepoint(java.sql.Connection conn,
java.lang.String id)
Rollback to SAVEPOINT if possible. |
void |
setSavepoint(java.sql.Connection conn,
java.lang.String id)
Issue a SAVEPOINT if possible. |
void |
setSessionTimeZone(java.sql.Connection conn,
java.lang.String regionName)
Sets the user session timezone on the Connection object. |
boolean |
shouldPutJoinConstraintInFromClause()
Checks if the FROM clause allows view criteria. |
protected boolean |
shouldSkipDML(EntityImpl entityContext,
int operation,
TransactionEvent e)
Checks if the entity needs to be posted to the database or not. |
boolean |
supportsReturningClause()
Checks if the database supports the Returning clause. |
boolean |
supportsRowNumQuery()
Checks if the database supports "rownum" identifier. |
Methods inherited from class oracle.jbo.server.CriteriaAdapterImpl |
---|
formatAttributeValue, getBindValsForSqlGen, getFormattedLHSCompareFragment, getFormattedRHSCompareFragment, getRowSetForSqlGen, getViewCriteriaClause, getWhereFragmentFromVO, isCriteriaItemOuterJoined, isLHSFragmentOptional, setupBindVarExtendedData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.jbo.server.SQLBuilder |
---|
getClauseForDateLiteral, isCharType, isNumericType |
Constructor Detail |
---|
public BaseSQLBuilderImpl()
Method Detail |
---|
public abstract java.lang.String getVersion()
SQLBuilder
getVersion
in interface SQLBuilder
public abstract java.lang.String getDbType()
SQLBuilder
getDbType
in interface SQLBuilder
public abstract java.lang.String getTypeMapName()
SQLBuilder
getTypeMapName
in interface SQLBuilder
public abstract java.lang.String getPersistManagerClassName()
SQLBuilder
getPersistManagerClassName
in interface SQLBuilder
public abstract java.lang.String getDbTimeQuery()
public abstract java.lang.String getDropTableSQL(java.lang.String dbObjectName)
SQLBuilder
Note: this method is subject to change.
getDropTableSQL
in interface SQLBuilder
dbObjectName
- name of the Table.
public abstract java.lang.String getCreateSequenceInsertTriggerSQL(java.lang.String triggerName, java.lang.String tableName, java.util.ArrayList sequenceNames, java.util.ArrayList colNames)
SQLBuilder
Supported for Oracle database only.
Note: this method is subject to change.
getCreateSequenceInsertTriggerSQL
in interface SQLBuilder
triggerName
- the name of the trigger.tableName
- the name of the table for which the trigger is created.sequenceNames
- the array of names of the sequence.colNames
- the arrya of names of the column to which the value of the sequence
is copied to.
public abstract java.lang.String getCreateSequenceSQL(java.lang.String sequenceName, int startVal)
SQLBuilder
Note: this method is subject to change.
getCreateSequenceSQL
in interface SQLBuilder
sequenceName
- name of the Sequence.startVal
- the initial value of the Sequence.
public abstract java.lang.String getDropSequenceSQL(java.lang.String sequenceName)
SQLBuilder
Note: this method is subject to change.
getDropSequenceSQL
in interface SQLBuilder
sequenceName
- name of the Sequence.
public abstract boolean isDisplayBindValueUI()
SQLBuilder
isDisplayBindValueUI
in interface SQLBuilder
public java.util.ArrayList getNestedTables(java.sql.Connection conn) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
getNestedTables
in interface SQLBuilder
conn
- the connection.
java.sql.SQLException
public int getDefaultBindingStyle()
getDefaultBindingStyle
in interface SQLBuilder
public void doRegisterDefaultDriver(java.lang.String url) throws java.sql.SQLException
SQLBuilder
doRegisterDefaultDriver
in interface SQLBuilder
url
- JDBC Connection url.
java.sql.SQLException
public void executeBatch(java.sql.PreparedStatement stmt) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
executeBatch
in interface SQLBuilder
stmt
- a PreparedStatement object.
java.sql.SQLException
protected boolean shouldSkipDML(EntityImpl entityContext, int operation, TransactionEvent e)
entityContext
- the entity object.operation
- the type of operation. For example INSERT, UPDATE.e
- the transaction event triggered.
protected LongRunningStatementHandle createHandleForCancellableStatements(DBTransactionImpl trans, java.sql.Statement stmt)
trans
- the transaction object.stmt
- the statement handle.
public void doEntityDML(EntityImpl entityContext, int operation, TransactionEvent e)
SQLBuilder
Note: this method is subject to change.
doEntityDML
in interface SQLBuilder
entityContext
- the Entity Object.operation
- one of DML_INSERT, DML_UPDATE, or DML_DELETE.e
- the transaction.public void doEntitySelect(EntityImpl entityContext, boolean lock)
SQLBuilder
Note: this method is subject to change. Note: this method is subject to change.
doEntitySelect
in interface SQLBuilder
entityContext
- the Entity Object.lock
- if true, a "SELECT for UPDATE" statement is used.public void doEntitySelectForAltKey(EntityImpl entityContext, int keyIndex, boolean lock)
doEntitySelectForAltKey
in interface SQLBuilder
public void setSavepoint(java.sql.Connection conn, java.lang.String id) throws java.sql.SQLException
SQLBuilder
setSavepoint
in interface SQLBuilder
conn
- the Connection used to create a savepoint.id
- the id for a savepoint.
java.sql.SQLException
public void rollbackToSavepoint(java.sql.Connection conn, java.lang.String id) throws java.sql.SQLException
SQLBuilder
rollbackToSavepoint
in interface SQLBuilder
conn
- the Connection used to rollback the savepoint.id
- the id for a savepoint
java.sql.SQLException
public void releaseSavepoint(java.sql.Connection conn, java.lang.String id) throws java.sql.SQLException
SQLBuilder
releaseSavepoint
in interface SQLBuilder
conn
- the Connection used to release the savepoint.id
- the id for a savepoint
java.sql.SQLException
public void doStatementSetRowPrefetch(java.sql.Statement ps, int prefetchSize) throws java.sql.SQLException
SQLBuilder
doStatementSetRowPrefetch
in interface SQLBuilder
ps
- the Statement object.prefetchSize
- the fetch size.
java.sql.SQLException
public void doStatementSetBindingStyle(java.sql.Statement ps, int bindingStyle)
SQLBuilder
doStatementSetBindingStyle
in interface SQLBuilder
ps
- the Statement object.bindingStyle
- valid values are BINDING_STYLE_JDBC, BINDING_STYLE_ORACLE,
BINDING_STYLE_ORACLE_NAME.public void doStatementSetBindingStyleDefault(java.sql.Statement ps)
SQLBuilder
Note: this method is subject to change.
doStatementSetBindingStyleDefault
in interface SQLBuilder
ps
- the Statement object.public void doPreparedStatementDefineColumnType(java.sql.PreparedStatement ps, int colnum, int sqltype) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
doPreparedStatementDefineColumnType
in interface SQLBuilder
ps
- the PreparedStatement object.colnum
- the column number.sqltype
- the type of the column.
java.sql.SQLException
public void doPreparedStatementDefines(java.sql.PreparedStatement ps, AttributeDefImpl[] attrs)
SQLBuilder
Note: this method is subject to change.
doPreparedStatementDefines
in interface SQLBuilder
ps
- the PreparedStatement object.attrs
- the attribute definitions.public void populateJboTypeMapEntries()
SQLBuilder
Note: this method is subject to change.
populateJboTypeMapEntries
in interface SQLBuilder
public void populateCompOpers()
populateCompOpers
in interface SQLBuilder
public java.lang.Object doLoadFromResultSet(java.lang.Object theTypeFactory, java.lang.Object theElemFactory, java.lang.Class theJavaType, byte attrLoad, java.sql.ResultSet rs, int index, DBTransactionImpl trans)
SQLBuilder
Note: this method is subject to change.
doLoadFromResultSet
in interface SQLBuilder
theTypeFactory
- a custom factory to be used for constructing new instances.theElemFactory
- currently unused.theJavaType
- the Java datatype of the Object to be created.attrLoad
- specifies if the load type is
ATTR_LOAD_EACH
,
ATTR_LOAD_BULK
or
ATTR_LOAD_SKIP
rs
- the resultset.index
- the index of the object to be loaded.trans
- the reference to the transaction object used to fetch the resultset.
public java.lang.Object[] doLoadBulkFromResultSet(AttributeDefImpl[] attrDefs, int attrIndex, java.sql.ResultSet rs, int index, DBTransactionImpl trans)
SQLBuilder
Note: this method is subject to change.
doLoadBulkFromResultSet
in interface SQLBuilder
attrDefs
- the list of attributes to be loaded.attrIndex
- a particular attribute from the list - Currently unused.rs
- the ResultSet containing the objects.index
- the index of the object in the result set to be loaded.trans
- the reference to the transaction object used to fetch the resultset.
public java.lang.Object doLoadFromStatement(java.lang.Object theTypeFactory, java.lang.Object theElemFactory, java.lang.Class theJavaType, java.sql.PreparedStatement ps, int index, Transaction trans)
SQLBuilder
Note: this method is subject to change.
doLoadFromStatement
in interface SQLBuilder
theTypeFactory
- a custom factory to be used for constructing new instances.theElemFactory
- currently unused.theJavaType
- the Java datatype of the Object to be created.ps
- the statement reference used to retrieve the Object.index
- the index of the object in the output list.trans
- the reference to the transaction object used to fetch the resultset.
public java.lang.Object generatePKBasedRef(EntityImpl entityContext)
SQLBuilder
Note: this method is subject to change.
generatePKBasedRef
in interface SQLBuilder
entityContext
- the entity object reference.public java.lang.Object[] generateRefAndOID(EntityImpl entityContext)
SQLBuilder
Note: this method is subject to change.
generateRefAndOID
in interface SQLBuilder
entityContext
- the entity object reference.public boolean isStreamType(int sqlTypeId)
SQLBuilder
Note: this method is subject to change.
isStreamType
in interface SQLBuilder
sqlTypeId
- the type to check for streaming support.public java.lang.Object generateRowID(EntityImpl entityContext)
SQLBuilder
The ROWID attribute can be used to gain faster access to the underyling database data.
Obtain the value for the ROWID attribute. If this entity doesn't support ROWID attributes, then return NULL. If, for some reason the value of the ROWID attribute isn't present, then return null.
Note: this method is subject to change.
generateRowID
in interface SQLBuilder
entityContext
- the entity object reference.
public java.util.Vector getTableList(java.sql.Connection conn, java.lang.String defaultUserName, java.lang.String userName, boolean bTable, boolean bAlias, boolean bView, boolean bSnap) throws java.lang.Exception
SQLBuilder
getTables(Connection, String, String, boolean, boolean, boolean, boolean)
.
Note: this method is subject to change.
getTableList
in interface SQLBuilder
conn
- the connection object.defaultUserName
- the user name of the connection. This is will also
be treated as the schema name for non-oracle databases.userName
- the user name for which the tables need to be listed.bTable
- flag to include Table objects in the list.bAlias
- flag to include Synonyms in the list - Oracle database only.bView
- flag to include View objects in the list.bSnap
- flag to include Materialized View objects in the list.
java.lang.Exception
public java.util.Vector getTableList(java.sql.Connection conn, java.lang.String defaultUserName, java.lang.String userName, boolean bTable, boolean bAlias, boolean bView, boolean bSnap, boolean bIncludeNested) throws java.lang.Exception
SQLBuilder
getTables(Connection, String, String, boolean, boolean, boolean, boolean, boolean)
.
Note: this method is subject to change.
getTableList
in interface SQLBuilder
conn
- the connection object.defaultUserName
- the user name of the connection. This is will also
be treated as the schema name for non-oracle databases.userName
- the user name for which the tables need to be listed.bTable
- flag to include Table objects in the list.bAlias
- flag to include Synonyms in the list - Oracle database only.bView
- flag to include View objects in the list.bSnap
- flag to include Materialized View objects in the list.bIncludeNested
- flag to include Nested table objects in the list.
java.lang.Exception
public java.util.ArrayList getTables(java.sql.Connection conn, java.lang.String defaultUserName, java.lang.String userName, java.lang.String nameFilter, boolean bTable, boolean bAlias, boolean bView, boolean bSnap) throws java.lang.Exception
SQLBuilder
Note: this method is subject to change.
getTables
in interface SQLBuilder
conn
- the connection object.defaultUserName
- the user name of the connection. This is will also
be treated as the schema name for non-oracle databases.userName
- the user name for which the tables need to be listed.nameFilter
- the filter for the name of the table to be listed.bTable
- flag to include Table objects in the list.bAlias
- flag to include Synonyms in the list - Oracle database only.bView
- flag to include View objects in the list.bSnap
- flag to include Materialized View objects in the list.
java.lang.Exception
public java.util.ArrayList getTables(java.sql.Connection conn, java.lang.String defaultUserName, java.lang.String userName, boolean bTable, boolean bAlias, boolean bView, boolean bSnap) throws java.lang.Exception
SQLBuilder
getTables(Connection, String, String, String, boolean, boolean, boolean, boolean)
with
no filter on the table name.
Note: this method is subject to change.
getTables
in interface SQLBuilder
conn
- the connection object.defaultUserName
- the user name of the connection. This is will also
be treated as the schema name for non-oracle databases.userName
- the user name for which the tables need to be listed.bTable
- flag to include Table objects in the list.bAlias
- flag to include Synonyms in the list - Oracle database only.bView
- flag to include View objects in the list.bSnap
- flag to include Materialized View objects in the list.
java.lang.Exception
public java.util.ArrayList getTables(java.sql.Connection conn, java.lang.String defaultUserName, java.lang.String userName, java.lang.String nameFilter, boolean bTable, boolean bAlias, boolean bView, boolean bSnap, boolean bIncludeNested) throws java.lang.Exception
SQLBuilder
getTables(Connection, String, String, String, boolean, boolean, boolean, boolean)
with
an additional parameter to fetch nested tables. Nested tables are fetched only
for Oracle database and OLite.
Note: this method is subject to change.
getTables
in interface SQLBuilder
conn
- the connection object.defaultUserName
- the user name of the connection. This is will also
be treated as the schema name for non-oracle databases.userName
- the user name for which the tables need to be listed.nameFilter
- the filter for the name of the table to be listed.bTable
- flag to include Table objects in the list.bAlias
- flag to include Synonyms in the list - Oracle database only.bView
- flag to include View objects in the list.bSnap
- flag to include Materialized View objects in the list.bIncludeNested
- flag to include Nested table objects in the list.
java.lang.Exception
public java.util.ArrayList getTables(java.sql.Connection conn, java.lang.String defaultUserName, java.lang.String userName, boolean bTable, boolean bAlias, boolean bView, boolean bSnap, boolean bIncludeNested) throws java.lang.Exception
SQLBuilder
getTables(Connection, String, String, String, boolean, boolean, boolean, boolean)
with
no filter on the table name and an additional parameter to fetch nested tables. Nested
tables are fetched only for Oracle database and OLite.
Note: this method is subject to change.
getTables
in interface SQLBuilder
conn
- the connection object.defaultUserName
- the user name of the connection. This is will also
be treated as the schema name for non-oracle databases.userName
- the user name for which the tables need to be listed.bTable
- flag to include Table objects in the list.bAlias
- flag to include Synonyms in the list - Oracle database only.bView
- flag to include View objects in the list.bSnap
- flag to include Materialized View objects in the list.bIncludeNested
- flag to include Nested table objects in the list.
java.lang.Exception
public java.util.ArrayList getDBPackageList(java.sql.Connection connection, java.lang.String userName, java.lang.String packageFilter) throws java.lang.Exception
SQLBuilder
getDBPackageList(Connection conn, String userName)
.
Note: this method is subject to change.
getDBPackageList
in interface SQLBuilder
connection
- the connection object.userName
- the user name for which database packages need to be listed.packageFilter
- the filter the database packages need to be listed.
java.lang.Exception
public java.util.ArrayList getDBOperationList(java.sql.Connection connection, java.lang.String userName, java.lang.String packageFilter, java.lang.String operationFilter) throws java.lang.Exception
SQLBuilder
Note: this method is subject to change.
getDBOperationList
in interface SQLBuilder
connection
- the connection object.userName
- the user name for which the database functions and procedures need to be listed.packageFilter
- the filter the database packages in which the functions and procedures need to be listed.operationFilter
- the filter the database functions and procedures need to be listed.
java.lang.Exception
public java.lang.String checkTableNameForQuotes(java.lang.String tableName)
SQLBuilder
Note: this method is subject to change.
checkTableNameForQuotes
in interface SQLBuilder
tableName
- the name of the table.
protected boolean needsQuotedTableName(java.lang.String tableName)
tableName
- the table name.
protected java.lang.String getQuotationMarkLeft()
protected java.lang.String getQuotationMarkRight()
protected boolean getLockTrailerIsAtEnd()
protected java.lang.String[] convertFlags(boolean bTable, boolean bAlias, boolean bView, boolean bSnap)
public java.util.Vector getSchemaList(java.sql.Connection conn) throws java.lang.Exception
SQLBuilder
Note: this method is subject to change.
getSchemaList
in interface SQLBuilder
java.lang.Exception
public java.util.ArrayList getSchemas(java.sql.Connection conn) throws java.lang.Exception
SQLBuilder
Note: this method is subject to change.
getSchemas
in interface SQLBuilder
java.lang.Exception
protected java.lang.String getWarningText(java.lang.String message)
message
- the warning message.
protected abstract java.lang.String getJDBCDriverClassName(java.lang.String url)
url
- JDBC Connection url.
public java.lang.StringBuffer buildUpdateStatement(EntityImpl entityContext, AttributeDefImpl[] cols, AttributeDefImpl[] retrCols, AttributeDefImpl[] retrKeyCols, boolean batchMode)
SQLBuilder
Note: this method is subject to change.
buildUpdateStatement
in interface SQLBuilder
entityContext
- the entity object.cols
- the columns to be included in the UPDATE statement.retrCols
- the Columns whose values need to be fetched after the UPDATE succeeds.retrKeyCols
- the Columns that are used as Keys to fetch post-update values.batchMode
- a flag to indicate if the UPDATE statement needs to be optimized
for batch mode.
public int bindInsertStatement(EntityImpl entityContext, java.sql.PreparedStatement stmt, AttributeDefImpl[] cols, AttributeDefImpl[] retrCols, AttributeDefImpl[] retrKeyCols, java.util.HashMap retrList, boolean batchMode) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
bindInsertStatement
in interface SQLBuilder
entityContext
- the entity object.stmt
- the statement handle executing the INSERT statement.cols
- the columns involved in the INSERT statement.retrCols
- the columns whose values need to be fetched after a
successful insert.retrKeyCols
- the columns that act as a key to fetch the newly
inserted values.retrList
- a map containing the references to store the fetched
values.batchMode
- flag to indicate binding for batchMode.
java.sql.SQLException
public int bindUpdateStatement(EntityImpl entityContext, java.sql.PreparedStatement stmt, AttributeDefImpl[] cols, AttributeDefImpl[] retrCols, AttributeDefImpl[] retrKeyCols, java.util.HashMap retrList, boolean batchMode) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
bindUpdateStatement
in interface SQLBuilder
entityContext
- the entity object.stmt
- the statement handle executing the UPDATE statement.cols
- the columns involved in the UPDATE statement.retrCols
- the columns whose values need to be fetched after a
successful insert.retrKeyCols
- the columns that act as a key to fetch the newly
inserted values.retrList
- a map containing the references to store the fetched
values.batchMode
- flag to indicate binding for batchMode.
java.sql.SQLException
public int bindDeleteStatement(EntityImpl entityContext, java.sql.PreparedStatement stmt) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
bindDeleteStatement
in interface SQLBuilder
entityContext
- the entity object.stmt
- the statement handle executing the DELETE statement.
java.sql.SQLException
protected int bindParamValue(int bindingStyle, java.lang.Object value, DBTransactionImpl trans, java.sql.PreparedStatement stmt, AttributeDefImpl attrDef, int bindIndex, boolean skipNull) throws java.sql.SQLException
bindingStyle
- one of the SQLBuilder binding style constants.value
- the object value to bind.trans
- the transaction object.stmt
- the Statement object carrying out the SQL.attrDef
- the defintion of the attribute to which the value belongs.bindIndex
- the parameter index in the PreparedStatement.skipNull
- indicates if the null values need to be bound or skipped.
java.sql.SQLException
protected int bindWhereAttrValue(EntityImpl entityContext, DBTransactionImpl trans, java.sql.PreparedStatement stmt, AttributeDefImpl attrDef, int bindIndex, boolean skipNull) throws java.sql.SQLException
entityContext
- the entity object.trans
- the transaction object.stmt
- the Statement object carrying out the SQL.attrDef
- the defintion of the attribute to which the value belongs.bindIndex
- the parameter index in the PreparedStatement.skipNull
- indicates if the null values need to be bound or skipped.
java.sql.SQLException
public int bindWhereClause(EntityImpl entityContext, java.sql.PreparedStatement stmt, java.lang.Object rowid, int bindIndex) throws java.sql.SQLException
SQLBuilder
The presence or absence of the ROWID value determines whether the ROWID will be used for Row access.
Note: this method is subject to change.
bindWhereClause
in interface SQLBuilder
entityContext
- the Entity row.stmt
- the statement to bind the columns to.rowid
- the ROWID for the row if known.bindIndex
- the baseline idx for performing the bind operations.
java.sql.SQLException
public int bindWhereClause(EntityImpl entityContext, java.sql.PreparedStatement stmt, AttributeDefImpl[] keyCols, java.lang.Object rowid, int bindIndex) throws java.sql.SQLException
SQLBuilder
The presence or absence of the ROWID value determines whether the ROWID will be used for Row access.
Note: this method is subject to change.
bindWhereClause
in interface SQLBuilder
entityContext
- the Entity row.stmt
- the statement to bind the columns to.keyCols
- the Primary Key Cols for the Entity row.rowid
- the ROWID for the row if known.bindIndex
- the baseline idx for performing the bind operations.
java.sql.SQLException
public int bindOptUpdateWhereClause(EntityImpl entityContext, java.sql.PreparedStatement stmt, int bindIndex) throws java.sql.SQLException
entityContext
- the entity definition.stmt
- the Statement object.bindIndex
- the current bind index.
java.sql.SQLException
protected java.lang.Object getROWID(EntityImpl entityContext)
entityContext
- the entity object.
public void buildWhereClause(EntityImpl entityContext, java.lang.StringBuffer buffer, AttributeDefImpl[] keyCols, java.lang.Object rowid)
SQLBuilder
Note: this method is subject to change.
buildWhereClause
in interface SQLBuilder
entityContext
- the entity object.buffer
- the StringBuffer object to which the WHERE clause is appended.keyCols
- the key attributes.rowid
- a rowid object if present.public void buildOptUpdateWhereClause(EntityImpl entityContext, java.lang.StringBuffer buffer, AttributeDefImpl[] cols)
entityContext
- the entity definition.buffer
- the storage for the WHERE clause.cols
- the attributes to be considered for fetching.public java.lang.StringBuffer buildInsertStatement(EntityImpl entityContext, AttributeDefImpl[] cols, AttributeDefImpl[] retrCols, AttributeDefImpl[] retrKeyCols, boolean batchMode)
SQLBuilder
Note: this method is subject to change.
buildInsertStatement
in interface SQLBuilder
entityContext
- the entity object.cols
- the columns to be included in the INSERT statement.retrCols
- the Columns whose values need to be fetched after the INSERT succeeds.retrKeyCols
- the Columns that are used as Keys to fetch post-insert values.batchMode
- a flag to indicate if the INSERT statement needs to be optimized
for batch mode.
public java.lang.StringBuffer buildDeleteStatement(EntityImpl entityContext)
SQLBuilder
Note: this method is subject to change.
buildDeleteStatement
in interface SQLBuilder
entityContext
- the entity object.
public static void baseBuildSelectList(java.lang.StringBuffer buffer, AttributeDefImpl[] attrs, java.lang.String sourceName, boolean forViewObject)
buffer
- the storage for the WHERE clause.attrs
- the attributes to be considered for the select list.sourceName
- the name of the table - unused.public void buildSelectList(java.lang.StringBuffer buffer, AttributeDefImpl[] attrs, java.lang.String sourceName, boolean forViewObject)
SQLBuilder
Note: this method is subject to change.
buildSelectList
in interface SQLBuilder
buffer
- the StringBuffer object to which the SELECT list is appended.attrs
- the list of attribute definitions to be considered for the SELECT list.sourceName
- the database object name that contains the attributes.public void buildSelectString(DBTransactionImpl trans, java.lang.StringBuffer buffer, java.lang.String sourceName, java.lang.String sourceAlias, AttributeDefImpl[] attrs, boolean withIntoClause, int bindingStyle)
SQLBuilder
Note: this method is subject to change.
buildSelectString
in interface SQLBuilder
trans
- a reference to the transaction object.buffer
- the StringBuffer object to which the SELECT statement is appended.sourceName
- the database object from which the Columns are selected.sourceAlias
- the database object alias.attrs
- the attributes that are selected from the database object.withIntoClause
- a boolean that indicates if an INTO Clause needs to be generated.bindingStyle
- specifies if Oracle, Oracle named parameter or JDBC binding style
is used in generating the parameter markers for the INTO clause.protected void buildSelectString(java.lang.StringBuffer buffer, java.lang.String sourceName, AttributeDefImpl[] attrs, boolean withIntoClause)
buffer
- the area into which the SELECT statement will be placed.sourceName
- the database object from which the Columns are selected.attrs
- the attributes that are selected from the database object.withIntoClause
- a boolean that indicates if an INTO Clause needs to be generated.public java.util.Vector getConstraints(java.sql.Connection conn, java.lang.String catalog, java.lang.String schema, java.lang.String table) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
getConstraints
in interface SQLBuilder
conn
- the connection object.catalog
- the database catalog.schema
- the database schema.table
- the name of the table.
java.sql.SQLException
public java.util.ArrayList getConstraintsList(java.sql.Connection conn, java.lang.String catalog, java.lang.String user_or_schema, java.lang.String full_tablename) throws java.sql.SQLException
SQLBuilder
1 String constraint_name
2 String constraint_type
3 String table_name
4 String search_condition
5 Integer delete_rule (cascade)
6 Integer status (enabled)
7 Integerdeferrable
8 Integer deferred
9 Integer validated
10 String column_name
11 Integer position
12 String fkname
13 String fkother
Note: this method is subject to change.
getConstraintsList
in interface SQLBuilder
conn
- the connection object.catalog
- the database catalog.user_or_schema
- the database schema.full_tablename
- the name of the table.
java.sql.SQLException
public java.lang.String getBaseTable(java.sql.Connection conn, java.lang.String schema, java.lang.String name) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
getBaseTable
in interface SQLBuilder
conn
- the connection object.schema
- the database schema.name
- the name of the potential synonym.
java.sql.SQLException
public javax.sql.DataSource lookupDataSource(java.lang.String nsUrl, java.lang.String nsUser, java.lang.String nsPasswd, java.lang.String dataSourceName) throws JboException
SQLBuilder
Note: this method is subject to change.
lookupDataSource
in interface SQLBuilder
nsUrl
- the provider URL.nsUser
- the username to connect to the provider.nsPasswd
- the password to connect to the provider.dataSourceName
- the name of the datasource.
JboException
public boolean isDataSourceJTABased(javax.sql.DataSource ds)
SQLBuilder
Note: this method is subject to change.
isDataSourceJTABased
in interface SQLBuilder
ds
- the DataSource object.
public boolean supportsReturningClause()
SQLBuilder
supportsReturningClause
in interface SQLBuilder
public boolean supportsRowNumQuery()
SQLBuilder
Note: this method is subject to change.
supportsRowNumQuery
in interface SQLBuilder
public java.lang.String buildRangePagingQuery(ViewObjectImpl vo, java.lang.String qry, int noUserParams)
buildRangePagingQuery
in interface SQLBuilder
public void bindRangePagingParams(java.sql.PreparedStatement stmt, ViewObjectImpl vo, int nextParamIndex, int rangeStart, int rangeSize)
bindRangePagingParams
in interface SQLBuilder
protected boolean capabilityCanReuseLockStatements()
protected java.lang.String getSqlVariantLockTrailer()
protected boolean getSupportsAliasInUpdateStatements()
protected static void dumpConstraint(java.lang.Object[] constraintEntry)
public ViewCriteriaAdapter getViewCriteriaAdapter()
SQLBuilder
Note: this method is subject to change.
getViewCriteriaAdapter
in interface SQLBuilder
protected java.lang.Object convertValueToWhereFragment(ViewCriteriaItem curDef, java.lang.String trimmedValue)
curDef
- the attribute definition.trimmedValue
- the literal value.
protected java.lang.Object convertValueToWhereFragment(ViewObject vo, ViewCriteria vc, ViewCriteriaItem curDef, java.lang.String trimmedValue)
vo
- the view object definitionvc
- the view criteria definition to
figure out if attribute value needs to be formattedcurDef
- the attribute definition.trimmedValue
- the literal value.
protected java.lang.String getFormattedRHSCompareFragment(AttributeDef attrDef, int sqlType, java.lang.String rhs)
attrDef
- the definition of the attribute.sqlType
- the type of the attribute value.rhs
- the value of the attribute.
public java.lang.String getFormattedRHSCompareFragment(ViewObject vo, ViewCriteria vc, AttributeDef attrDef, int sqlType, java.lang.String rhs)
getFormattedRHSCompareFragment
in interface SQLBuilder
vo
- the view object definition.vc
- the view criteria definition.attrDef
- the definition of the attribute.sqlType
- the type of the attribute value.rhs
- the value of the attribute.
public java.lang.String getFormattedLHSCompareFragment(ViewObject vo, ViewCriteria vc, AttributeDef attrDef, int sqlType, java.lang.String lhs, java.lang.Object rhs)
SQLBuilder
getFormattedLHSCompareFragment
in interface SQLBuilder
vo
- the view object instance, could be null if unavailable in the contextvc
- the view criteria instance, could be null if unavailable in the contextattrDef
- the definition of the attribute.sqlType
- the type of the attribute value.rhs
- the value of the attribute.
protected java.lang.String getColumnNameWithFormatForQuery(java.lang.String lhspart, AttributeDef attrDef, int sqltype)
public java.sql.Timestamp getCurrentDbTime(java.sql.Connection conn)
SQLBuilder
getCurrentDbTime
in interface SQLBuilder
conn
- the connection object.
public void doRefreshSQL(EntityImpl entityContext, int operation, AttributeDefImpl[] columns, AttributeDefImpl[] retrKeyCols)
SQLBuilder
Note: this method is subject to change.
doRefreshSQL
in interface SQLBuilder
entityContext
- the Entity row.operation
- SQL Operationcolumns
- Columns to be selected.retrKeyCols
- Key columns to appear be to used to refresh, which appear in WHERE clause.public java.lang.String getQueryHitCountSQL(RowSet rs)
SQLBuilder
Note: this method is subject to change.
getQueryHitCountSQL
in interface SQLBuilder
rs
- the RowSet object.
public java.lang.String getCappedQueryHitCountSQL(RowSet rs, long cap)
getCappedQueryHitCountSQL
in interface SQLBuilder
public boolean isConnectionAlive(java.sql.Connection conn)
SQLBuilder
isConnectionAlive
in interface SQLBuilder
conn
- the connection object.
public java.lang.Object convertValueToStorageType(java.lang.Object value)
SQLBuilder
Note: this method is subject to change.
convertValueToStorageType
in interface SQLBuilder
value
- the object that needs to be converted.
public void jdbcClientSideSecurity(java.util.Properties info, java.util.Hashtable env)
SQLBuilder
Note: this method is subject to change.
jdbcClientSideSecurity
in interface SQLBuilder
info
- the properties object to which the values are copied to.env
- the environment object to lookup the security attributes.public boolean compareFetchedValue(EntityImpl entity, AttributeDefImpl ad, java.lang.Object cacheValue, java.lang.Object fetchedValue)
SQLBuilder
Note: this method is subject to change.
compareFetchedValue
in interface SQLBuilder
entity
- the entity object.ad
- the attribute definition of the value being compared.cacheValue
- the cached value.fetchedValue
- the new fetched value.
public void bindParametersForStmt(int bindingStyle, java.lang.Object[] params, java.sql.PreparedStatement stmt) throws java.sql.SQLException
SQLBuilder
Note: this method is subject to change.
bindParametersForStmt
in interface SQLBuilder
bindingStyle
- specifies if Oracle, Oracle named parameter or JDBC binding style
is used.params
- the list of parameters.stmt
- the statement to be executed.
java.sql.SQLException
public void processException(java.lang.String errorCode, java.lang.Exception sqlEx, java.lang.Object[] params)
SQLBuilder
SQLStmtException
or JboException
.
Note: this method is subject to change.
processException
in interface SQLBuilder
errorCode
- the SQL execution errorcode.sqlEx
- the Exception object.params
- the query parameters.public boolean invalidDatumFactoryUsage(java.lang.String colType, int id, java.lang.Class clz)
SQLBuilder
invalidDatumFactoryUsage
in interface SQLBuilder
public int getMaxTableNameLength(java.sql.Connection conn)
SQLBuilder
getMaxTableNameLength
in interface SQLBuilder
conn
- the Database connection object
public boolean isNewLineAllowedInSQL(java.sql.Connection conn)
SQLBuilder
isNewLineAllowedInSQL
in interface SQLBuilder
conn
- the Database connection object
public static int getBindingStyleValue(java.lang.String bindingStyleStr)
public void buildDefaultViewObjectFromClause(java.lang.StringBuffer fromClause, java.util.List eRefs)
SQLBuilder
buildDefaultViewObjectFromClause
in interface SQLBuilder
public void buildDefaultViewObjectFromClause(java.lang.StringBuffer fromClause, java.util.List eRefs, BaseViewCriteriaManagerImpl vcManager)
SQLBuilder
ViewDefImpl.setFromClauseFlags(ViewDefImpl.CLAUSE_GENERATE_RT)
buildDefaultViewObjectFromClause
in interface SQLBuilder
fromClause
- A StringBuffer
object that would be appended with
the generated "from" clause.eRefs
- The EntityReference
objects that should be considered
for generation of the "from" clause.vcManager
- In ANSI generation, view criteria associated with the
EntityAssociationReference are part of the FROM clause, and vcManager
is used to build the where clause fragment.
if NULL, view criteria won't be builtpublic boolean shouldPutJoinConstraintInFromClause()
SQLBuilder
shouldPutJoinConstraintInFromClause
in interface SQLBuilder
public java.util.HashMap buildDefaultViewObjectWhereClause(java.lang.StringBuffer whereClause, java.util.List eRefs, java.util.List forcedERefs, EntityReference[][] newEntRefsArr, boolean isInlineViewForFroms)
SQLBuilder
ViewDefImpl.setWhereClauseFlags(ViewDefImpl.CLAUSE_GENERATE_RT)
buildDefaultViewObjectWhereClause
in interface SQLBuilder
whereClause
- A StringBuffer
object that would be appended with
the generated "where" clause.eRefs
- The EntityReference
objects that should be considered
for generation of the "where" clause.public java.lang.String buildEffDtDateDayAddStatement()
SQLBuilder
buildEffDtDateDayAddStatement
in interface SQLBuilder
String
that contains the necessary SQL.public void bindEffDtDateDayAddStatement(java.sql.PreparedStatement stmt, java.lang.Object date, int days) throws java.sql.SQLException
SQLBuilder
bindEffDtDateDayAddStatement
in interface SQLBuilder
stmt
- The PreparedStatment
object that needs to be bound
with the valuesdate
- The specified datedays
- The number of days the resulting date needs to differ from the
specified date. It could be a positive or a negative number
java.sql.SQLException
public void setSessionTimeZone(java.sql.Connection conn, java.lang.String regionName)
SQLBuilder
setSessionTimeZone
in interface SQLBuilder
conn
- Connection objectregionName
- timezone region, for example: America/New_Yorkpublic ADFDatabaseChangeListener registerDatabaseChangeListener(QueryCollection listener, java.sql.Connection conn, java.sql.Statement stmt)
SQLBuilder
registerDatabaseChangeListener
in interface SQLBuilder
listener
- The Query Collection that holds the qualifying rowsconn
- Connection objectstmt
- The SQL Statement that needs to be monitored for the
database to trigger notifications.
public boolean isNCharType(java.sql.Statement stmt, int index)
SQLBuilder
isNCharType
in interface SQLBuilder
stmt
- A select statement that has been executedindex
- The position of the column to be tested for international character typepublic boolean containsTableAlias(java.lang.String clause, java.lang.String alias)
containsTableAlias
in interface SQLBuilder
public int findTableAliasInSQLExpr(java.lang.String clause, java.lang.String alias, int start)
public java.lang.String processClauseReplaceTableAliases(java.lang.String clause, RowReference[] origEntRefs, RowReference[] newEntRefs, boolean isSQLExpr, boolean[] isModified)
processClauseReplaceTableAliases
in interface SQLBuilder
public java.lang.String processClauseForSubQuery(java.lang.String clause, EntityReference[] entRefs, java.lang.String suffix, boolean isSQLExpr, boolean[] isModified)
processClauseForSubQuery
in interface SQLBuilder
public java.lang.String getStringConcatOper(boolean bIncludeSpaces)
SQLBuilder
getStringConcatOper
in interface SQLBuilder
getStringConcatOper
in class CriteriaAdapterImpl
bIncludeSpaces
- if the database platform allows spaces before and
after the operator the returned string may include the spaces if the passed
flag is true
.
public boolean isSQLRecoverableException(java.lang.Exception ex)
isSQLRecoverableException
in interface SQLBuilder
ex
- the exception to analyze.
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |