oracle.toplink.queryframework
Class ObjectLevelReadQuery

java.lang.Object
  oracle.toplink.queryframework.DatabaseQuery
      oracle.toplink.queryframework.ReadQuery
          oracle.toplink.queryframework.ObjectBuildingQuery
              oracle.toplink.queryframework.ObjectLevelReadQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.toplink.internal.helper.FalseUndefinedTrue

Direct Known Subclasses:

ReadAllQuery, ReadObjectQuery

public abstract class ObjectLevelReadQuery
extends ObjectBuildingQuery

Purpose: Abstract class for all read queries using objects.

Description: Contains common behavior for all read queries using objects.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

static int	CheckCacheByExactPrimaryKey
static int	CheckCacheByPrimaryKey
static int	CheckCacheOnly
static int	CheckCacheThenDatabase
static int	ConformResultsInUnitOfWork
static int	DoNotCheckCache
static short	DONT_USE_DISTINCT
static short	UNCOMPUTED_DISTINCT
static short	USE_DISTINCT
static int	UseDescriptorSetting

Fields inherited from class oracle.toplink.queryframework.ObjectBuildingQuery

DEFAULT_LOCK_MODE, LOCK, LOCK_NOWAIT, NO_LOCK

Fields inherited from class oracle.toplink.queryframework.DatabaseQuery

CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, CascadePrivateParts, NoCascading

Method Summary

void	acquireLocks() Set the query to lock, this will also turn refreshCache on.
void	acquireLocksWithoutWaiting() Set the query to lock without waiting (blocking), this will also turn refreshCache on.
void	addJoinedAttribute(Expression attributeExpression) Specify the attribute to be join fetched in this query.
void	addJoinedAttribute(java.lang.String attributeName) Specify the one-to-one mapped attribute to be join fetched in this query.
void	addNonFetchJoinedAttribute(Expression attributeExpression) Specify the one-to-one mapped attribute to be optimized in this query.
void	addNonFetchJoinedAttribute(java.lang.String attributeName) Specify the one-to-one mapped attribute to be optimized in this query.
void	addPartialAttribute(Expression attributeExpression) Specify that only a subset of the class' attributes be selected in this query.
void	addPartialAttribute(java.lang.String attributeName) Specify that only a subset of the class' attributes be selected in this query.
void	checkCacheOnly() The cache will checked completely, if the object is not found null will be returned or an error if the query is too complex.
void	conformResultsInUnitOfWork() The cache will checked completely, if the object is not found the database will be queried, and the database result will be verified with what is in the cache and/or unit of work including new objects.
void	dontAcquireLocks() Set the query not to lock.
void	dontCheckCache() This can be used to explicitly disable the cache hit.
void	dontRefreshIdentityMapResult() When unset means perform read normally and dont do refresh.
void	dontRefreshRemoteIdentityMapResult() When unset means perform read normally and dont do refresh.
void	dontUseDistinct() ADVANCED: If a distinct has been set the DISTINCT clause will be printed.
AsOfClause	getAsOfClause() ADVANCED: Answers the past time this query is as of.
int	getCacheUsage() Return the cache usage.
short	getDistinctState() ADVANCED: If a distinct has been set the DISTINCT clause will be printed.
java.lang.Object	getExampleObject() This method returns the current example object.
ExpressionBuilder	getExpressionBuilder() REQUIRED: Get the expression builder which should be used for this query.
FetchGroup	getFetchGroup() Return the fetch group set in the query.
java.lang.String	getFetchGroupName() Return the fetch group name set in the query.
InMemoryQueryIndirectionPolicy	getInMemoryQueryIndirectionPolicy() Returns the InMemoryQueryIndirectionPolicy for this query
int	getInMemoryQueryIndirectionPolicyState() Returns the InMemoryQueryIndirectionPolicy for this query
short	getLockMode() Return the current locking mode.
QueryByExamplePolicy	getQueryByExamplePolicy() When using Query By Example, an instance of QueryByExamplePolicy is used to customize the query.
java.lang.Class	getReferenceClass() Return the reference class of the query.
boolean	hasAsOfClause() Answers if the domain objects are to be read as of a past time.
boolean	hasFetchGroup() Return if a fetch group is set in the query.
boolean	isLockQuery() Answers if the query lock mode is known to be LOCK or LOCK_NOWAIT.
boolean	isLockQuery(Session session) ADVANCED: Answers if this query will issue any pessimistic locks.
boolean	isObjectLevelReadQuery() Return if this is an object level read query.
boolean	isReadOnly() Return if the query is read-only.
boolean	isResultSetOptimizedQuery() ADVANCED: Return if the query should be optimized to build directly from the result set.
void	refreshIdentityMapResult() Refresh the attributes of the object(s) resulting from the query.
void	refreshRemoteIdentityMapResult() Refresh the attributes of the object(s) resulting from the query.
void	resetDistinct() ADVANCED: If a distinct has been set the DISTINCT clause will be printed.
void	setAsOfClause(AsOfClause pastTime) ADVANCED: Sets the query to execute as of the past time.
void	setCacheUsage(int cacheUsage) Set the cache usage.
void	setDistinctState(short distinctState) ADVANCED: If a distinct has been set the DISTINCT clause will be printed.
void	setEJBQLString(java.lang.String ejbqlString) Set the EJBQL string of the query.
void	setExampleObject(java.lang.Object newExampleObject) Set the example object of the query to be the newExampleObject.
void	setFetchGroup(FetchGroup newFetchGroup) Set a dynamic (use case) fetch group to the query.
void	setFetchGroupName(java.lang.String groupName) Set a descriptor-level pre-defined named fetch group to the query.
void	setInMemoryQueryIndirectionPolicy(InMemoryQueryIndirectionPolicy inMemoryQueryIndirectionPolicy) Set the InMemoryQueryIndirectionPolicy for this query.
void	setInMemoryQueryIndirectionPolicyState(int inMemoryQueryIndirectionPolicy) Set the InMemoryQueryIndirectionPolicy for this query.
void	setIsReadOnly(boolean isReadOnly) Set the query to be read-only.
void	setIsResultSetOptimizedQuery(boolean isResultSetOptimizedQuery) ADVANCED: Set if the query should be optimized to build directly from the result set.
void	setLockMode(short lockMode) Sets whether this is a pessimistically locking query.
void	setQueryByExamplePolicy(QueryByExamplePolicy queryByExamplePolicy) The QueryByExamplePolicy, is a useful to customize the query when Query By Example is used.
void	setReferenceClass(java.lang.Class aClass) REQUIRED: Set the reference class for the query.
void	setSelectionCriteria(Expression expression) To any user of this object.
void	setShouldFilterDuplicates(boolean shouldFilterDuplicates) Set if duplicate rows should be filter when using 1-m joining.
void	setShouldOuterJoinSubclasses(boolean shouldOuterJoinSubclasses) Set if an outer join should be used to read subclasses.
void	setShouldProcessResultsInUnitOfWork(boolean processResultsInUnitOfWork) ADVANCED: Used for CMP only.
void	setShouldRefreshIdentityMapResult(boolean shouldRefreshIdentityMapResult) Set if the attributes of the object(s) resulting from the query should be refreshed.
void	setShouldRefreshRemoteIdentityMapResult(boolean shouldRefreshIdentityMapResult) Set if the attributes of the object(s) resulting from the query should be refreshed.
void	setShouldUseDefaultFetchGroup(boolean shouldUseDefaultFetchGroup) Set false if the user does not want to use the default fetch group defined in the descriptor level.
boolean	shouldCheckCacheOnly() Return if cache should be checked.
boolean	shouldCheckDescriptorForCacheUsage() Return whether the descriptor's disableCacheHits setting should be checked prior to querying the cache.
boolean	shouldConformResultsInUnitOfWork() Should the results will be checked against the changes within the unit of work and object no longer matching or deleted will be remove, matching new objects will also be added..
boolean	shouldFilterDuplicates() Return if duplicate rows should be filter when using 1-m joining.
boolean	shouldOuterJoinSubclasses() Return if an outer join should be used to read subclasses.
boolean	shouldProcessResultsInUnitOfWork() ADVANCED: Used for CMP only.
boolean	shouldRefreshIdentityMapResult() Set to a boolean.
boolean	shouldRefreshRemoteIdentityMapResult() Set to a boolean.
boolean	shouldUseDefaultFetchGroup() Return false if the query does not use the default fetch group defined in the descriptor level.
java.lang.String	toString()
void	useDistinct() ADVANCED: If a distinct has been set the DISTINCT clause will be printed.

Methods inherited from class oracle.toplink.queryframework.ObjectBuildingQuery

isObjectBuildingQuery, setShouldUseExclusiveConnection, shouldUseExclusiveConnection

Methods inherited from class oracle.toplink.queryframework.ReadQuery

cacheQueryResults, clearQueryResults, clearQueryResults, doNotCacheQueryResults, getFetchSize, getFirstResult, getMaxRows, getQueryResultsCachePolicy, isReadQuery, setFetchSize, setFirstResult, setMaxRows, setQueryResultsCachePolicy, setShouldCacheQueryResults, shouldCacheQueryResults

Methods inherited from class oracle.toplink.queryframework.DatabaseQuery

addArgument, addArgument, addArgument, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, cacheStatement, cascadeAllParts, cascadeByMapping, cascadePrivateParts, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, getCall, getCalls, getDatasourceCall, getDatasourceCalls, getEJBQLString, getFlushOnExecute, getHintString, getJPQLString, getName, getQueryTimeout, getRedirector, getSelectionCriteria, getSessionName, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isDataModifyQuery, isDataReadQuery, isDeleteAllQuery, isDeleteObjectQuery, isDirectReadQuery, isExpressionQuery, isInsertObjectQuery, isModifyAllQuery, isModifyQuery, isNativeConnectionRequired, isObjectLevelModifyQuery, isReadAllQuery, isReadObjectQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isValueReadQuery, isWriteObjectQuery, maintainCache, prepareCall, setCall, setDatasourceCall, setFlushOnExecute, setHintString, setIsNativeConnectionRequired, setJPQLString, setName, setQueryTimeout, setRedirector, setSessionName, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldUseWrapperPolicy, setSQLStatement, setSQLString, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeParts, shouldCascadePrivateParts, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

UseDescriptorSetting

public static final int UseDescriptorSetting

See Also:

Constant Field Values

DoNotCheckCache

public static final int DoNotCheckCache

See Also:

Constant Field Values

CheckCacheByExactPrimaryKey

public static final int CheckCacheByExactPrimaryKey

See Also:

Constant Field Values

CheckCacheByPrimaryKey

public static final int CheckCacheByPrimaryKey

See Also:

Constant Field Values

CheckCacheThenDatabase

public static final int CheckCacheThenDatabase

See Also:

Constant Field Values

CheckCacheOnly

public static final int CheckCacheOnly

See Also:

Constant Field Values

ConformResultsInUnitOfWork

public static final int ConformResultsInUnitOfWork

See Also:

Constant Field Values

UNCOMPUTED_DISTINCT

public static final short UNCOMPUTED_DISTINCT

See Also:

Constant Field Values

USE_DISTINCT

public static final short USE_DISTINCT

See Also:

Constant Field Values

DONT_USE_DISTINCT

public static final short DONT_USE_DISTINCT

See Also:

Constant Field Values

Method Detail

isReadOnly

public boolean isReadOnly()

Return if the query is read-only. This allows queries executed against a UnitOfWork to be read-only. This means the query will be executed against the Session, and the resulting objects will not be tracked for changes. The resulting objects are from the Session shared cache, and must not be modified.

setIsReadOnly

public void setIsReadOnly(boolean isReadOnly)

Set the query to be read-only. This allows queries executed against a UnitOfWork to be read-only. This means the query will be executed against the Session, and the resulting objects will not be tracked for changes. The resulting objects are from the Session shared cache, and must not be modified.

acquireLocks

public void acquireLocks()

Set the query to lock, this will also turn refreshCache on.

acquireLocksWithoutWaiting

public void acquireLocksWithoutWaiting()

Set the query to lock without waiting (blocking), this will also turn refreshCache on.

addJoinedAttribute

public void addJoinedAttribute(java.lang.String attributeName)

Specify the one-to-one mapped attribute to be join fetched in this query. The query will join the object(s) being read with the one-to-one attribute, this allows all of the data required for the object(s) to be read in a single query instead of (n) queries. This should be used when the application knows that it requires the part for all of the objects being read.

Note: This cannot be used for objects where it is possible not to have a part, as these objects will be ommited from the result set, unless an outer join is used through passing and expression using "getAllowingNull". To join fetch collection relationships use the addJoinedAttribute(Expression) using "anyOf" ot "anyOfAllowingNone".

Example: query.addJoinedAttribute("address")

See Also:

addJoinedAttribute(Expression), ReadAllQuery.addBatchReadAttribute(Expression)

addJoinedAttribute

public void addJoinedAttribute(Expression attributeExpression)

Specify the attribute to be join fetched in this query. The query will join the object(s) being read with the specified attribute, this allows all of the data required for the object(s) to be read in a single query instead of (n) queries. This should be used when the application knows that it requires the part for all of the objects being read.

Note: This cannot be used for objects where it is possible not to have a part, as these objects will be ommited from the result set, unless an outer join is used through passing and expression using "getAllowingNull".

Example: The following will fetch along with Employee(s) "Jones" all projects they participate in along with teamLeaders and their addresses, teamMembers and their phones. query.setSelectionCriteria(query.getExpressionBuilder().get("lastName").equal("Jones")); Expression projects = query.getExpressionBuilder().anyOf("projects"); query.addJoinedAttribute(projects); Expression teamLeader = projects.get("teamLeader"); query.addJoinedAttribute(teamLeader); Expression teamLeaderAddress = teamLeader.getAllowingNull("address"); query.addJoinedAttribute(teamLeaderAddress); Expression teamMembers = projects.anyOf("teamMembers"); query.addJoinedAttribute(teamMembers); Expression teamMembersPhones = teamMembers.anyOfAllowingNone("phoneNumbers"); query.addJoinedAttribute(teamMembersPhones); Note that: the order is essential: an expression should be added before any expression derived from it; the object is built once - it won't be rebuilt if it to be read again as a joined attribute: in the example the query won't get phones for "Jones" - even though they are among teamMembers (for whom phones are read).

addNonFetchJoinedAttribute

public void addNonFetchJoinedAttribute(java.lang.String attributeName)

Specify the one-to-one mapped attribute to be optimized in this query. The query will join the object(s) being read with the one-to-one attribute. The difference between this and a joined attribute is that it allows data to be retrieved based on a join, but will not populate the joined attribute. It also allows all of the data required for the object(s) to be read in a single query instead of (n) queries. This should be used when the application knows that it requires the part for all of the objects being read. This can be used only for one-to-one mappings where the target is not the same class as the source, either directly or through inheritance. Also two joins cannot be done to the same class.

Note: This cannot be used for objects where it is possible not to have a part, as these objects will be ommited from the result set, unless an outer join is used through passing and expression using "getAllowingNull".

Example: query.addNonFetchJoinedAttribute("address")

See Also:

addNonFetchJoinedAttribute(Expression)

addNonFetchJoinedAttribute

public void addNonFetchJoinedAttribute(Expression attributeExpression)

Specify the one-to-one mapped attribute to be optimized in this query. The query will join the object(s) being read with the one-to-one attribute. The difference between this and a joined attribute is that it allows data to be retrieved based on a join, but will not populate the joined attribute. It also allows all of the data required for the object(s) to be read in a single query instead of (n) queries. This should be used when the application knows that it requires the part for all of the objects being read. This can be used only for one-to-one mappings where the target is not the same class as the source, either directly or through inheritance. Also two joins cannot be done to the same class.

Note: This cannot be used for objects where it is possible not to have a part, as these objects will be ommited from the result set, unless an outer join is used through passing and expression using "getAllowingNull".

Example: query.addNonFetchJoinedAttribute(query.getExpressionBuilder().get("teamLeader").get("address"))

See Also:

addNonFetchJoinedAttribute(Expression)

addPartialAttribute

public void addPartialAttribute(java.lang.String attributeName)

Specify that only a subset of the class' attributes be selected in this query.

This allows for the query to be optimized through selecting less data.

Partial objects will be returned from the query, where the unspecified attributes will be left null. The primary key will always be selected to allow re-querying of the whole object.

Note: Because the object is not fully initialized it cannot be cached, and cannot be edited.

Note: You cannot have 2 partial attributes of the same type. You also cannot add a partial attribute which is of the same type as the class being queried.

Example: query.addPartialAttribute("firstName")

See Also:

addPartialAttribute(Expression)

setAsOfClause

public void setAsOfClause(AsOfClause pastTime)

ADVANCED: Sets the query to execute as of the past time. Both the query execution and result will conform to the database as it existed in the past.

Equivalent to query.getSelectionCriteria().asOf(pastTime) called immediately before query execution.

An as of clause at the query level will override any clauses set at the expression level. Useful in cases where the selection criteria is not known in advance, such as for query by example or primary key (selection object), or where you do not need to cache the result (report query).

Ideally an as of clause at the session level is superior as query results can then be cached. You must set setShouldMaintainCache(false)

To query all joined/batched attributes as of the same time set this.cascadeAllParts().

Throws:

QueryException - (at execution time) unless setShouldMaintainCache(false) is set. If some more recent data were in the cache, this would be returned instead, and both the cache and query result would become inconsistent.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

hasAsOfClause(), Session.acquireHistoricalSession(oracle.toplink.history.AsOfClause), Expression.asOf(oracle.toplink.history.AsOfClause)

addPartialAttribute

public void addPartialAttribute(Expression attributeExpression)

Specify that only a subset of the class' attributes be selected in this query.

This allows for the query to be optimized through selecting less data.

Partial objects will be returned from the query, where the unspecified attributes will be left null. The primary key will always be selected to allow re-querying of the whole object.

Note: Because the object is not fully initialized it cannot be cached, and cannot be edited.

Note: You cannot have 2 partial attributes of the same type. You also cannot add a partial attribute which is of the same type as the class being queried.

Example: query.addPartialAttribute(query.getExpressionBuilder().get("address").get("city"))

checkCacheOnly

public void checkCacheOnly()

The cache will checked completely, if the object is not found null will be returned or an error if the query is too complex. Queries can be configured to use the cache at several levels. Other caching option are available.

See Also:

setCacheUsage(int)

conformResultsInUnitOfWork

public void conformResultsInUnitOfWork()

The cache will checked completely, if the object is not found the database will be queried, and the database result will be verified with what is in the cache and/or unit of work including new objects. This can lead to poor performance so it is recomended that only the database be queried in most cases. Queries can be configured to use the cache at several levels. Other caching option are available.

See Also:

setCacheUsage(int)

dontAcquireLocks

public void dontAcquireLocks()

Set the query not to lock.

dontCheckCache

public void dontCheckCache()

This can be used to explicitly disable the cache hit. The cache hit may not be desired in some cases, such as stored procedures that accept the primary key but do not query on it.

dontRefreshIdentityMapResult

public void dontRefreshIdentityMapResult()

When unset means perform read normally and dont do refresh.

Overrides:

dontRefreshIdentityMapResult in class ObjectBuildingQuery

dontRefreshRemoteIdentityMapResult

public void dontRefreshRemoteIdentityMapResult()

When unset means perform read normally and dont do refresh.

Overrides:

dontRefreshRemoteIdentityMapResult in class ObjectBuildingQuery

dontUseDistinct

public void dontUseDistinct()

ADVANCED: If a distinct has been set the DISTINCT clause will be printed. This is used internally by TopLink for batch reading but may also be used directly for advanced queries or report queries.

getAsOfClause

public AsOfClause getAsOfClause()

ADVANCED: Answers the past time this query is as of.

Returns:

An immutable object representation of the past time. null if no clause set, AsOfClause.NO_CLAUSE if clause explicitly set to null.

See Also:

AsOfClause, setAsOfClause(oracle.toplink.history.AsOfClause), hasAsOfClause()

getCacheUsage

public int getCacheUsage()

Return the cache usage. By default only primary key read object queries will first check the cache before accessing the database. Any query can be configure to query against the cache completely, by key or ignore the cache check.

Valid values are:

• DoNotCheckCache
• CheckCacheByExactPrimaryKey
• CheckCacheByPrimaryKey
• CheckCacheThenDatabase
• CheckCacheOnly
• ConformResultsInUnitOfWork
• UseDescriptorSetting Note: UseDescriptorSetting functions like CheckCacheByPrimaryKey, except checks the appropriate descriptor's shouldDisableCacheHits setting when querying on the cache.

getDistinctState

public short getDistinctState()

ADVANCED: If a distinct has been set the DISTINCT clause will be printed. This is used internally by TopLink for batch reading but may also be used directly for advanced queries or report queries.

getExampleObject

public java.lang.Object getExampleObject()

This method returns the current example object. The "example" object is an actual domain object, provided by the client, from which an expression is generated. This expression is used for a query of all objects from the same class, that match the attribute values of the "example" object.

getExpressionBuilder

public ExpressionBuilder getExpressionBuilder()

REQUIRED: Get the expression builder which should be used for this query. This expression builder should be used to build all expressions used by this query.

getInMemoryQueryIndirectionPolicyState

public int getInMemoryQueryIndirectionPolicyState()

Returns the InMemoryQueryIndirectionPolicy for this query

getInMemoryQueryIndirectionPolicy

public InMemoryQueryIndirectionPolicy getInMemoryQueryIndirectionPolicy()

Returns the InMemoryQueryIndirectionPolicy for this query

shouldFilterDuplicates

public boolean shouldFilterDuplicates()

Return if duplicate rows should be filter when using 1-m joining.

setShouldFilterDuplicates

public void setShouldFilterDuplicates(boolean shouldFilterDuplicates)

Set if duplicate rows should be filter when using 1-m joining.

getLockMode

public short getLockMode()

Return the current locking mode.

Overrides:

getLockMode in class ObjectBuildingQuery

getQueryByExamplePolicy

public QueryByExamplePolicy getQueryByExamplePolicy()

When using Query By Example, an instance of QueryByExamplePolicy is used to customize the query. The policy is useful when special operations are to be used for comparisons (notEqual, lessThan, greaterThan, like etc.), when a certain value is to be ignored, or when dealing with nulls.

getReferenceClass

public java.lang.Class getReferenceClass()

Return the reference class of the query.

Overrides:

getReferenceClass in class ObjectBuildingQuery

hasAsOfClause

public boolean hasAsOfClause()

Answers if the domain objects are to be read as of a past time.

See Also:

getAsOfClause()

isLockQuery

public boolean isLockQuery()

Answers if the query lock mode is known to be LOCK or LOCK_NOWAIT. In the case of DEFAULT_LOCK_MODE and the query reference class being a CMP entity bean, at execution time LOCK, LOCK_NOWAIT, or NO_LOCK will be decided.

If a single joined attribute was configured for pessimistic locking then this will return true (after first execution) as the SQL contained a FOR UPDATE OF clause.

Overrides:

isLockQuery in class ObjectBuildingQuery

isLockQuery

public boolean isLockQuery(Session session)

ADVANCED: Answers if this query will issue any pessimistic locks.

If the lock mode is not known (DEFAULT_LOCK_MODE / descriptor specified fine-grained locking) the lock mode will be determined now, to be either LOCK, LOCK_NOWAIT, or NO_LOCK.

See Also:

isLockQuery()

isObjectLevelReadQuery

public boolean isObjectLevelReadQuery()

Return if this is an object level read query.

Overrides:

isObjectLevelReadQuery in class DatabaseQuery

refreshIdentityMapResult

public void refreshIdentityMapResult()

Refresh the attributes of the object(s) resulting from the query. If cascading is used the private parts of the objects will also be refreshed.

Overrides:

refreshIdentityMapResult in class ObjectBuildingQuery

refreshRemoteIdentityMapResult

public void refreshRemoteIdentityMapResult()

Refresh the attributes of the object(s) resulting from the query. If cascading is used the private parts of the objects will also be refreshed.

Overrides:

refreshRemoteIdentityMapResult in class ObjectBuildingQuery

resetDistinct

public void resetDistinct()

ADVANCED: If a distinct has been set the DISTINCT clause will be printed. This is used internally by TopLink for batch reading but may also be used directly for advanced queries or report queries.

setCacheUsage

public void setCacheUsage(int cacheUsage)

Set the cache usage. By default only primary key read object queries will first check the cache before accessing the database. Any query can be configure to query against the cache completely, by key or ignore the cache check.

Valid values are:

• DoNotCheckCache - The query does not check the cache but accesses the database, the cache will still be maintain.
• CheckCacheByExactPrimaryKey - If the query is exactly and only on the object's primary key the cache will be checked.
• CheckCacheByPrimaryKey - If the query contains the primary key and possible other values the cache will be checked.
• CheckCacheThenDatabase - The whole cache will be checked to see if there is any object matching the query, if not the database will be accessed.
• CheckCacheOnly - The whole cache will be checked to see if there is any object matching the query, if not null or an empty collection is returned.
• ConformResultsAgainstUnitOfWork - The results will be checked againtst the changes within the unit of work and object no longer matching or deleted will be remove, matching new objects will also be added.
• shouldCheckDescriptorForCacheUsage - This setting functions like CheckCacheByPrimaryKey, except checks the appropriate descriptor's shouldDisableCacheHits setting when querying on the cache.

setDistinctState

public void setDistinctState(short distinctState)

ADVANCED: If a distinct has been set the DISTINCT clause will be printed. This is used internally by TopLink for batch reading but may also be used directly for advanced queries or report queries.

setExampleObject

public void setExampleObject(java.lang.Object newExampleObject)

Set the example object of the query to be the newExampleObject. The example object is used for Query By Example. When doing a Query By Example, an instance of the desired object is created, and the fields are filled with the values that are required in the result set. From these values the corresponding expression is built by TopLink, and the query is executed, returning the set of results.

If a query already has a selection criteria this criteria and the generated query by example criteria will be conjuncted.

Once a query is executed you must make an explicit call to setExampleObject if the example object is changed, so the query will know to prepare itself again.

There is a caution to setting both a selection criteria and an example object: Only in this case if you set the example object again after execution you must then also reset the selection criteria. (This is because after execution the original criteria and Query By Example criteria were fused together, and the former cannot be easily recovered from the now invalid result).

setInMemoryQueryIndirectionPolicy

public void setInMemoryQueryIndirectionPolicy(InMemoryQueryIndirectionPolicy inMemoryQueryIndirectionPolicy)

Set the InMemoryQueryIndirectionPolicy for this query.

setInMemoryQueryIndirectionPolicyState

public void setInMemoryQueryIndirectionPolicyState(int inMemoryQueryIndirectionPolicy)

Set the InMemoryQueryIndirectionPolicy for this query.

setLockMode

public void setLockMode(short lockMode)

Sets whether this is a pessimistically locking query.

• ObjectBuildingQuery.LOCK: SELECT .... FOR UPDATE issued.
• ObjectBuildingQuery.LOCK_NOWAIT: SELECT .... FOR UPDATE NO WAIT issued.
• ObjectBuildingQuery.NO_LOCK: no pessimistic locking.
• ObjectBuildingQuery.DEFAULT_LOCK_MODE (default) and you have a CMP descriptor: fine grained locking will occur.

Fine Grained Locking: On execution the reference class and those of all joined attributes will be checked. If any of these have a PessimisticLockingPolicy set on their descriptor, they will be locked in a SELECT ... FOR UPDATE OF ... {NO WAIT}. Issues fewer locks and avoids setting the lock mode on each query.

Example:readAllQuery.setSelectionCriteria(employee.get("address").equal("Ottawa"));

• LOCK: all employees in Ottawa and all referenced Ottawa addresses will be locked.
• DEFAULT_LOCK_MODE: if address is a joined attribute, and only address has a pessimistic locking policy, only referenced Ottawa addresses will be locked.

Overrides:

setLockMode in class ObjectBuildingQuery

See Also:

PessimisticLockingPolicy

setEJBQLString

public void setEJBQLString(java.lang.String ejbqlString)

Description copied from class: oracle.toplink.queryframework.DatabaseQuery

Set the EJBQL string of the query. If arguments are required in the string they will be preceeded by "?" then the argument number.

Overrides:

setEJBQLString in class DatabaseQuery

setQueryByExamplePolicy

public void setQueryByExamplePolicy(QueryByExamplePolicy queryByExamplePolicy)

The QueryByExamplePolicy, is a useful to customize the query when Query By Example is used. The policy will control what attributes should, or should not be included in the query. When dealing with nulls, using specail operations (notEqual, lessThan, like, etc.) for comparison, or chosing to include certain attributes at all times, it is useful to modify the policy accordingly.

Once a query is executed you must make an explicit call to setQueryByExamplePolicy when changing the policy, so the query will know to prepare itself again.

There is a caution to setting both a selection criteria and an example object: If you set the policy after execution you must also reset the selection criteria. (This is because after execution the original criteria and Query By Example criteria are fused together, and the former cannot be easily recovered).

setReferenceClass

public void setReferenceClass(java.lang.Class aClass)

REQUIRED: Set the reference class for the query.

Overrides:

setReferenceClass in class ObjectBuildingQuery

setSelectionCriteria

public void setSelectionCriteria(Expression expression)

Description copied from class: oracle.toplink.queryframework.DatabaseQuery

To any user of this object. Set the selection criteria of the query. This method be used when dealing with expressions.

Overrides:

setSelectionCriteria in class DatabaseQuery

setShouldRefreshIdentityMapResult

public void setShouldRefreshIdentityMapResult(boolean shouldRefreshIdentityMapResult)

Set if the attributes of the object(s) resulting from the query should be refreshed. If cascading is used the private parts of the objects will also be refreshed.

Overrides:

setShouldRefreshIdentityMapResult in class ObjectBuildingQuery

setShouldRefreshRemoteIdentityMapResult

public void setShouldRefreshRemoteIdentityMapResult(boolean shouldRefreshIdentityMapResult)

Set if the attributes of the object(s) resulting from the query should be refreshed. If cascading is used the private parts of the objects will also be refreshed.

Overrides:

setShouldRefreshRemoteIdentityMapResult in class ObjectBuildingQuery

shouldCheckCacheOnly

public boolean shouldCheckCacheOnly()

Return if cache should be checked.

shouldCheckDescriptorForCacheUsage

public boolean shouldCheckDescriptorForCacheUsage()

Return whether the descriptor's disableCacheHits setting should be checked prior to querying the cache.

shouldConformResultsInUnitOfWork

public boolean shouldConformResultsInUnitOfWork()

Should the results will be checked against the changes within the unit of work and object no longer matching or deleted will be remove, matching new objects will also be added..

shouldOuterJoinSubclasses

public boolean shouldOuterJoinSubclasses()

Return if an outer join should be used to read subclasses. By default a seperate query is done for each subclass when querying for a root or branch inheritance class that has subclasses that span multiple tables.

setShouldOuterJoinSubclasses

public void setShouldOuterJoinSubclasses(boolean shouldOuterJoinSubclasses)

Set if an outer join should be used to read subclasses. By default a seperate query is done for each subclass when querying for a root or branch inheritance class that has subclasses that span multiple tables.

shouldRefreshIdentityMapResult

public boolean shouldRefreshIdentityMapResult()

Set to a boolean. When set means refresh the instance variables of referenceObject from the database.

Overrides:

shouldRefreshIdentityMapResult in class ObjectBuildingQuery

shouldRefreshRemoteIdentityMapResult

public boolean shouldRefreshRemoteIdentityMapResult()

Set to a boolean. When set means refresh the instance variables of referenceObject from the database.

Overrides:

shouldRefreshRemoteIdentityMapResult in class ObjectBuildingQuery

toString

public java.lang.String toString()

Overrides:

toString in class ObjectBuildingQuery

setShouldProcessResultsInUnitOfWork

public void setShouldProcessResultsInUnitOfWork(boolean processResultsInUnitOfWork)

ADVANCED: Used for CMP only. This allows users to indicate whether cmp finders executed at the beginning of a transaction should always be run against a UnitOfWork. Defaults to true.

If set to false, then UnitOfWork allocation will be deferred until a business method (including creates/removes) or finder with shouldProcessResultsInUnitOfWork == true is invoked. Any finder executed before such a time, will do so against the underlying ServerSession. Forcing finder execution to always go through a UnitOfWork means the results will be cloned and cached in the UnitOfWork up front. This is desired when the results will be accessed in the same transaction.

Note that finders executed with an unspecified transaction context will never be executed against a UnitOfWork, even if this setting is true. This case may happen with the NotSupported, Never, and Supports attributes.

Overrides:

setShouldProcessResultsInUnitOfWork in class ObjectBuildingQuery

shouldProcessResultsInUnitOfWork

public boolean shouldProcessResultsInUnitOfWork()

ADVANCED: Used for CMP only. Indicates whether cmp finders executed at the beginning of a transaction should always be run against a UnitOfWork. Defaults to true.

If set to false, then UnitOfWork allocation will be deferred until a business method (including creates/removes) or finder with shouldProcessResultsInUnitOfWork == true is invoked. Any finder executed before such a time, will do so against the underlying ServerSession. Forcing finder execution to always go through a UnitOfWork means the results will be cloned and cached in the UnitOfWork up front. This is desired when the results will be accessed in the same transaction.

Note that finders executed with an unspecified transaction context will never be executed against a UnitOfWork, even if this setting is true. This case may happen with the NotSupported, Never, and Supports attributes.

Overrides:

shouldProcessResultsInUnitOfWork in class ObjectBuildingQuery

useDistinct

public void useDistinct()

ADVANCED: If a distinct has been set the DISTINCT clause will be printed. This is used internally by TopLink for batch reading but may also be used directly for advanced queries or report queries.

isResultSetOptimizedQuery

public boolean isResultSetOptimizedQuery()

ADVANCED: Return if the query should be optimized to build directly from the result set. This optimization follows an optimized path and can only be used for, singleton primary key, direct mapped, simple type, no inheritance, uow isolated objects.

setIsResultSetOptimizedQuery

public void setIsResultSetOptimizedQuery(boolean isResultSetOptimizedQuery)

ADVANCED: Set if the query should be optimized to build directly from the result set. This optimization follows an optimized path and can only be used for, singleton primary key, direct mapped, simple type, no inheritance, uow isolated objects.

hasFetchGroup

public boolean hasFetchGroup()

Return if a fetch group is set in the query.

getFetchGroup

public FetchGroup getFetchGroup()

Return the fetch group set in the query. If a fetch group is not explicitly set in the query, default fetch group optionally defined in the decsiptor would be used, unless the user explicitly calls query.setShouldUseDefaultFetchGroup(false).

Overrides:

getFetchGroup in class ObjectBuildingQuery

setFetchGroup

public void setFetchGroup(FetchGroup newFetchGroup)

Set a dynamic (use case) fetch group to the query.

setFetchGroupName

public void setFetchGroupName(java.lang.String groupName)

Set a descriptor-level pre-defined named fetch group to the query.

getFetchGroupName

public java.lang.String getFetchGroupName()

Return the fetch group name set in the query.

shouldUseDefaultFetchGroup

public boolean shouldUseDefaultFetchGroup()

Return false if the query does not use the default fetch group defined in the descriptor level.

setShouldUseDefaultFetchGroup

public void setShouldUseDefaultFetchGroup(boolean shouldUseDefaultFetchGroup)

Set false if the user does not want to use the default fetch group defined in the descriptor level.