|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) B32476-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.toplink.descriptors.DescriptorQueryManager
public class DescriptorQueryManager
Purpose: The query manager allows for the database opperations that TopLink performs to be customized by the application. For each descriptor a query can be given that controls how a operation will occur. A common example is if the application requires a stored procedure to be used to insert the object, it can override the SQL call in the insert query that TopLink will use to insert the object. Queries can be customized to extend TopLink behavior, access non-relational data or use stored procedures or customized SQL calls.
The queries that can be customized include:
ClassDescriptor
,
Serialized FormField Summary | |
---|---|
static int |
DefaultTimeout
|
static int |
NoTimeout
queryTimeout has three possible settings: DefaultTimeout, NoTimeout, and 1..N This applies to both DatabaseQuery.queryTimeout and DescriptorQueryManager.queryTimeout DatabaseQuery.queryTimeout: - DefaultTimeout: get queryTimeout from DescriptorQueryManager - NoTimeout, 1..N: overrides queryTimeout in DescriptorQueryManager DescriptorQueryManager.queryTimeout: - DefaultTimeout: get queryTimeout from parent DescriptorQueryManager. |
Method Summary | |
---|---|
void |
addQuery(DatabaseQuery query)
Add the query to the session queries |
void |
addQuery(java.lang.String name,
DatabaseQuery query)
Add the query to the descriptor queries with the given name |
void |
assumeExistenceForDoesExist()
Assume that if the objects primary key does not include null then it must exist. |
void |
assumeNonExistenceForDoesExist()
Assume that the object does not exist. |
void |
checkCacheForDoesExist()
Default behavior. |
void |
checkDatabaseForDoesExist()
Perform does exist check on the database |
boolean |
containsQuery(java.lang.String queryName)
Return true if the query is defined on the session |
Expression |
getAdditionalJoinExpression()
ADVANCED: Returns the join expression that should be appended to all of the descriptors expressions Contains any multiple table or inheritance dependencies |
java.util.Vector |
getAllQueries()
Return the pre-defined queries for the descriptor. |
Call |
getDeleteCall()
ADVANCED: Return the receiver's delete call. |
DeleteObjectQuery |
getDeleteQuery()
ADVANCED: Return the receiver's delete query. |
java.lang.String |
getDeleteSQLString()
ADVANCED: Return the receiver's delete SQL string. |
Call |
getDoesExistCall()
ADVANCED: Return the receiver's does-exist call. |
DoesExistQuery |
getDoesExistQuery()
ADVANCED: Return the receiver's does exist query. |
java.lang.String |
getDoesExistSQLString()
ADVANCED: Return the receiver's does exist SQL string. |
int |
getExpressionQueryCacheMaxSize()
ADVANCED: Return the max size of the expression query cache for avoiding regenerated dynamic query SQL. |
Call |
getInsertCall()
ADVANCED: Return the receiver's insert call. |
InsertObjectQuery |
getInsertQuery()
ADVANCED: Return the receiver's insert query. |
java.lang.String |
getInsertSQLString()
ADVANCED: Return the receiver's insert SQL string. |
DatabaseQuery |
getLocalQuery(java.lang.String name,
java.util.Vector arguments)
INTENAL: Return the query from the set of pre-defined queries with the given name and argument types. |
DatabaseQuery |
getLocalQueryByArgumentTypes(java.lang.String name,
java.util.Vector argumentTypes)
INTENAL: Return the query from the set of pre-defined queries with the given name and argument types. |
Expression |
getMultipleTableJoinExpression()
ADVANCED: This is normally generated for descriptors that have multiple tables. |
java.util.Map |
getQueries()
Return the pre-defined queries for the descriptor. |
DatabaseQuery |
getQuery(java.lang.String queryName)
Return the query name from the set of pre-defined queries If only one query exists with this name, it will be returned. |
DatabaseQuery |
getQuery(java.lang.String name,
java.util.Vector arguments)
Return the query from the set of pre-defined queries with the given name and argument types. |
int |
getQueryTimeout()
Return the number of seconds queries will wait for their Statement to execute |
Call |
getReadAllCall()
ADVANCED: Return the receiver's read-all call. |
ReadAllQuery |
getReadAllQuery()
ADVANCED: Return the receiver's read query. |
java.lang.String |
getReadAllSQLString()
ADVANCED: Return the receiver's read SQL string. |
Call |
getReadObjectCall()
ADVANCED: Return the receiver's read-object call. |
ReadObjectQuery |
getReadObjectQuery()
ADVANCED: Return the receiver's read query. |
java.lang.String |
getReadObjectSQLString()
ADVANCED: Return the receiver's read SQL string. |
Call |
getUpdateCall()
ADVANCED: Return the receiver's update call. |
int |
getUpdateCallCacheSize()
ADVANCED: Return the size of the update call cache. |
UpdateObjectQuery |
getUpdateQuery()
ADVANCED: Return the receiver's update query. |
java.lang.String |
getUpdateSQLString()
ADVANCED: Return the receiver's update SQL string. |
void |
removeQuery(java.lang.String queryName)
Remove all queries with the given query name from the set of pre-defined queries |
void |
removeQuery(java.lang.String queryName,
java.util.Vector argumentTypes)
Remove the specific query with the given queryName and argumentTypes. |
void |
setAdditionalJoinExpression(Expression additionalJoinExpression)
ADVANCED: Set the additional join expression. |
void |
setDeleteCall(Call call)
ADVANCED: Set the receiver's delete call. |
void |
setDeleteQuery(DeleteObjectQuery query)
ADVANCED: Set the receiver's delete query. |
void |
setDeleteSQLString(java.lang.String sqlString)
ADVANCED: Set the receiver's delete SQL string. |
void |
setDoesExistCall(Call call)
ADVANCED: Set the receiver's does exist call. |
void |
setDoesExistQuery(DoesExistQuery query)
ADVANCED: Set the receiver's does exist query. |
void |
setDoesExistSQLString(java.lang.String sqlString)
ADVANCED: Set the receiver's does exist SQL string. |
void |
setExpressionQueryCacheMaxSize(int maxSize)
ADVANCED: Set the max size of the expression query cache for avoiding regenerated dynamic query SQL. |
void |
setInsertCall(Call call)
ADVANCED: Set the receiver's insert call. |
void |
setInsertQuery(InsertObjectQuery insertQuery)
ADVANCED: Set the receiver's insert query. |
void |
setInsertSQLString(java.lang.String sqlString)
ADVANCED: Set the receiver's insert SQL string. |
void |
setMultipleTableJoinExpression(Expression multipleTableJoinExpression)
ADVANCED: This is normally generated for descriptors that have multiple tables. |
void |
setQueries(java.util.Map map)
set the pre-defined queries for the descriptor. |
void |
setQueryTimeout(int queryTimeout)
Set the number of seconds that queries will wait for their Statement to execute. |
void |
setReadAllCall(Call call)
ADVANCED: Set the receiver's read all call. |
void |
setReadAllQuery(ReadAllQuery query)
ADVANCED: Set the receiver's read all query. |
void |
setReadAllSQLString(java.lang.String sqlString)
ADVANCED: Set the receiver's read SQL string. |
void |
setReadObjectCall(Call call)
ADVANCED: Set the receiver's read object call. |
void |
setReadObjectQuery(ReadObjectQuery query)
ADVANCED: Set the receiver's read query. |
void |
setReadObjectSQLString(java.lang.String sqlString)
ADVANCED: Set the receiver's read SQL string. |
void |
setUpdateCall(Call call)
ADVANCED: Set the receiver's update call. |
void |
setUpdateCallCacheSize(int updateCallCacheSize)
ADVANCED: Set the size of the update call cache. |
void |
setUpdateQuery(UpdateObjectQuery updateQuery)
ADVANCED: Set the receiver's update query. |
void |
setUpdateSQLString(java.lang.String sqlString)
ADVANCED: Set the receiver's update SQL string. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NoTimeout
DescriptorQueryManager
public static final int DefaultTimeout
Method Detail |
---|
public void setExpressionQueryCacheMaxSize(int maxSize)
public int getExpressionQueryCacheMaxSize()
public void addQuery(java.lang.String name, DatabaseQuery query)
name
- This is the name of the query. It will be set on the query and used to look it up.query
- This is the query that will be added. If the query being added has parameters, the
existing list of queries will be checked for matching queries. If a matching query exists,
it will be replaced.public void addQuery(DatabaseQuery query)
query
- DatabaseQuery This is the query that will be added. If the query being added has parameters, the
existing list of queries will be checked for matching queries. If a matching query exists,
it will be replaced.public void assumeExistenceForDoesExist()
public void assumeNonExistenceForDoesExist()
public void checkCacheForDoesExist()
public void checkDatabaseForDoesExist()
public boolean containsQuery(java.lang.String queryName)
public Expression getAdditionalJoinExpression()
public DeleteObjectQuery getDeleteQuery()
public java.lang.String getDeleteSQLString()
Example, "delete from EMPLOYEE where EMPLOYEE_ID = #EMPLOYEE_ID".
public DoesExistQuery getDoesExistQuery()
public java.lang.String getDoesExistSQLString()
Example, "select EMPLOYEE_ID from EMPLOYEE where EMPLOYEE_ID = #EMPLOYEE_ID".
public InsertObjectQuery getInsertQuery()
public java.lang.String getInsertSQLString()
Example, "insert into EMPLOYEE (F_NAME, L_NAME) values (#F_NAME, #L_NAME)".
public Expression getMultipleTableJoinExpression()
public java.util.Map getQueries()
getAllQueries()
public java.util.Vector getAllQueries()
getQueries()
public void setQueries(java.util.Map map)
public DatabaseQuery getQuery(java.lang.String queryName)
getQuery(String, Vector)
public DatabaseQuery getQuery(java.lang.String name, java.util.Vector arguments)
getQuery(String)
public DatabaseQuery getLocalQuery(java.lang.String name, java.util.Vector arguments)
getQuery(String)
public DatabaseQuery getLocalQueryByArgumentTypes(java.lang.String name, java.util.Vector argumentTypes)
getQuery(String)
public ReadAllQuery getReadAllQuery()
public java.lang.String getReadAllSQLString()
Example, "select * from EMPLOYEE"
public ReadObjectQuery getReadObjectQuery()
public java.lang.String getReadObjectSQLString()
Example, "select * from EMPLOYEE where EMPLOYEE_ID = #EMPLOYEE_ID"
public UpdateObjectQuery getUpdateQuery()
public java.lang.String getUpdateSQLString()
Example, "update EMPLOYEE set F_NAME to #F_NAME, L_NAME to #L_NAME where EMPLOYEE_ID = #EMPLOYEE_ID".
public void removeQuery(java.lang.String queryName)
removeQuery(String, Vector)
public void removeQuery(java.lang.String queryName, java.util.Vector argumentTypes)
removeQuery(String)
public void setAdditionalJoinExpression(Expression additionalJoinExpression)
public void setDeleteQuery(DeleteObjectQuery query)
public void setDeleteSQLString(java.lang.String sqlString)
Example, "delete from EMPLOYEE where EMPLOYEE_ID = #EMPLOYEE_ID".
public void setDeleteCall(Call call)
public void setDoesExistQuery(DoesExistQuery query)
public void setDoesExistSQLString(java.lang.String sqlString)
Example, "select EMPLOYEE_ID from EMPLOYEE where EMPLOYEE_ID = #EMPLOYEE_ID".
public void setDoesExistCall(Call call)
public void setInsertQuery(InsertObjectQuery insertQuery)
public void setInsertCall(Call call)
public void setInsertSQLString(java.lang.String sqlString)
Example, "insert into EMPLOYEE (F_NAME, L_NAME) values (#F_NAME, #L_NAME)".
public Call getInsertCall()
public Call getUpdateCall()
public Call getDeleteCall()
public Call getReadObjectCall()
public Call getReadAllCall()
public Call getDoesExistCall()
public void setMultipleTableJoinExpression(Expression multipleTableJoinExpression)
public void setReadAllQuery(ReadAllQuery query)
public void setReadAllSQLString(java.lang.String sqlString)
Example, "select * from EMPLOYEE"
public void setReadAllCall(Call call)
public void setReadObjectQuery(ReadObjectQuery query)
public void setReadObjectSQLString(java.lang.String sqlString)
Example, "select * from EMPLOYEE where EMPLOYEE_ID = #EMPLOYEE_ID"
public void setReadObjectCall(Call call)
public void setUpdateQuery(UpdateObjectQuery updateQuery)
public void setUpdateSQLString(java.lang.String sqlString)
Example, "update EMPLOYEE set F_NAME to #F_NAME, L_NAME to #L_NAME where EMPLOYEE_ID = #EMPLOYEE_ID".
public void setUpdateCall(Call call)
public int getQueryTimeout()
public void setQueryTimeout(int queryTimeout)
public int getUpdateCallCacheSize()
public void setUpdateCallCacheSize(int updateCallCacheSize)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |