|
EclipseLink1.0 - 20080707 API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.queries.DatabaseQuery org.eclipse.persistence.queries.ReadQuery org.eclipse.persistence.queries.ObjectBuildingQuery org.eclipse.persistence.queries.ObjectLevelReadQuery
public abstract class ObjectLevelReadQuery
Purpose: Abstract class for all read queries using objects.
Description: Contains common behavior for all read queries using objects.
Field Summary | |
---|---|
protected java.util.Vector |
additionalFields
Allow for additional fields to be selected, used for m-m batch reading. |
protected int |
cacheUsage
Allow for the cache usage to be specified to enable in-memory querying. |
static int |
CheckCacheByExactPrimaryKey
|
static int |
CheckCacheByPrimaryKey
|
static int |
CheckCacheOnly
|
static int |
CheckCacheThenDatabase
|
protected java.util.Map<java.lang.Class,org.eclipse.persistence.internal.databaseaccess.DatabaseCall> |
concreteSubclassCalls
Allow concrete subclasses calls to be prepared and cached for inheritance queries. |
static int |
ConformResultsInUnitOfWork
|
protected ExpressionBuilder |
defaultBuilder
Provide a default builder so that it's easier to be consistent |
protected short |
distinctState
Indicates if distinct should be used or not. |
static int |
DoNotCheckCache
|
static short |
DONT_USE_DISTINCT
|
protected long |
executionTime
Used to set the read time on objects that use this query. |
protected FetchGroup |
fetchGroup
Allow for a query level fetch group to be set. |
protected java.lang.String |
fetchGroupName
The pre-defined fetch group name. |
protected int |
inMemoryQueryIndirectionPolicy
Used to determine behavior of indirection in in-memory querying and conforming. |
protected boolean |
isPrePrepared
Allow a prePrepare stage to build the expression for EJBQL and QBE and resolve joining. |
protected boolean |
isReadOnly
PERF: Allow queries to be defined as read-only in unit of work execution. |
protected java.lang.Boolean |
isReferenceClassLocked
PERF: Caches locking policy isReferenceClassLocked setting. |
protected boolean |
isResultSetOptimizedQuery
PERF: Allow queries to build directly from the database result-set. |
protected org.eclipse.persistence.internal.queries.JoinedAttributeManager |
joinedAttributeManager
Stores the helper object for dealing with joined attributes |
protected java.util.Vector |
nonFetchJoinAttributeExpressions
Stores the non fetchjoin attributes, these are joins that will be represented in the where clause but not in the select. |
protected java.util.Vector |
partialAttributeExpressions
Stores the partial attributes that have been added to this query |
protected boolean |
shouldIncludeData
Allow for a complex result to be return including the rows and objects, used for m-m batch reading. |
protected java.lang.Boolean |
shouldOuterJoinSubclasses
Define if an outer join should be used to read subclasses. |
protected boolean |
shouldUseDefaultFetchGroup
Flag to turn on/off the use of the default fetch group. |
static short |
UNCOMPUTED_DISTINCT
|
static short |
USE_DISTINCT
|
static int |
UseDescriptorSetting
|
Fields inherited from class org.eclipse.persistence.queries.ObjectBuildingQuery |
---|
DEFAULT_LOCK_MODE, LOCK, LOCK_NOWAIT, LOCK_RESULT_PROPERTY, lockingClause, NO_LOCK, referenceClass, referenceClassName, shouldBuildNullForNullPk, shouldProcessResultsInUnitOfWork, shouldRefreshIdentityMapResult, shouldRefreshRemoteIdentityMapResult, shouldRegisterResultsInUnitOfWork, shouldUseExclusiveConnection, wasDefaultLockMode |
Fields inherited from class org.eclipse.persistence.queries.ReadQuery |
---|
fetchSize, firstResult, maxRows, queryId, queryResultCachingPolicy, temporaryCachedQueryResults |
Constructor Summary | |
---|---|
ObjectLevelReadQuery()
INTERNAL: Initialize the state of the query |
Method Summary | |
---|---|
void |
acquireLocks()
PUBLIC: Set the query to lock, this will also turn refreshCache on. |
void |
acquireLocksWithoutWaiting()
PUBLIC: Set the query to lock without waiting (blocking), this will also turn refreshCache on. |
void |
addAdditionalField(org.eclipse.persistence.internal.helper.DatabaseField field)
INTERNAL: Additional fields can be added to a query. |
void |
addAdditionalField(Expression fieldExpression)
INTERNAL: Additional fields can be added to a query. |
void |
addJoinedAttribute(Expression attributeExpression)
PUBLIC: Specify the attribute to be join fetched in this query. |
void |
addJoinedAttribute(java.lang.String attributeName)
PUBLIC: Specify the one-to-one mapped attribute to be join fetched in this query. |
void |
addNonFetchJoinedAttribute(Expression attributeExpression)
PUBLIC: Specify the one-to-one mapped attribute to be optimized in this query. |
void |
addNonFetchJoinedAttribute(java.lang.String attributeName)
PUBLIC: Specify the one-to-one mapped attribute to be optimized in this query. |
void |
addPartialAttribute(Expression attributeExpression)
PUBLIC: Specify that only a subset of the class' attributes be selected in this query. |
void |
addPartialAttribute(java.lang.String attributeName)
PUBLIC: Specify that only a subset of the class' attributes be selected in this query. |
protected void |
addSelectionFieldsForJoinedExpressions(java.util.List fields,
java.util.List joinedExpressions)
INTERNAL: Iterate through a list of joined expressions and add the fields they represent to a list of fields. |
java.lang.Object |
buildObject(org.eclipse.persistence.internal.sessions.AbstractRecord row)
INTERNAL: Used to build the object, and register it if in the context of a unit of work. |
void |
changeDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession theSession)
INTERNAL: The reference class has been changed, need to reset the descriptor. |
void |
checkCacheOnly()
PUBLIC: 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 |
checkDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Ensure that the descriptor has been set. |
java.lang.Object |
checkEarlyReturn(org.eclipse.persistence.internal.sessions.AbstractSession session,
org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
INTERNAL: Check to see if this query already knows the return value without performing any further work. |
protected abstract java.lang.Object |
checkEarlyReturnImpl(org.eclipse.persistence.internal.sessions.AbstractSession session,
org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
INTERNAL: Contains the body of the check early return call, implemented by subclasses. |
void |
checkPrepare(org.eclipse.persistence.internal.sessions.AbstractSession session,
org.eclipse.persistence.internal.sessions.AbstractRecord translationRow,
boolean force)
INTERNAL: Check to see if this query needs to be prepare and prepare it. |
protected void |
checkPrePrepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: ObjectLevelReadQueries now have an explicit pre-prepare stage, which is for checking for pessimistic locking, and computing any joined attributes declared on the descriptor. |
java.lang.Object |
clone()
INTERNAL: Clone the query |
protected java.lang.Object |
conformIndividualResult(java.lang.Object result,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork,
org.eclipse.persistence.internal.sessions.AbstractRecord arguments,
Expression selectionCriteriaClone,
java.util.Map alreadyReturned,
boolean buildDirectlyFromRows)
INTERNAL: Conforms and registers an individual result. |
void |
conformResultsInUnitOfWork()
PUBLIC: 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 |
copyFromQuery(DatabaseQuery query)
INTERNAL: Copy all setting from the query. |
java.lang.Object |
deepClone()
INTERNAL: Clone the query, including its selection criteria. |
void |
dontAcquireLocks()
PUBLIC: Set the query not to lock. |
void |
dontCheckCache()
PUBLIC: This can be used to explicitly disable the cache hit. |
void |
dontRefreshIdentityMapResult()
PUBLIC: When unset means perform read normally and dont do refresh. |
void |
dontRefreshRemoteIdentityMapResult()
PUBLIC: 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. |
boolean |
equals(java.lang.Object object)
INTERNAL: Return if the query is equal to the other. |
java.lang.Object |
execute(org.eclipse.persistence.internal.sessions.AbstractSession session,
org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
INTERNAL: Execute the query. |
java.lang.Object |
executeDatabaseQuery()
INTERNAL: Executes the prepared query on the datastore. |
java.lang.Object |
executeInUnitOfWork(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork,
org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
INTERNAL: Execute the query in the unit of work. |
protected abstract java.lang.Object |
executeObjectLevelReadQuery()
Executes the prepared query on the datastore. |
protected abstract java.lang.Object |
executeObjectLevelReadQueryFromResultSet()
Executes the prepared query on the datastore. |
java.util.Vector |
getAdditionalFields()
INTERNAL: Additional fields can be added to a query. |
AsOfClause |
getAsOfClause()
ADVANCED: Answers the past time this query is as of. |
int |
getCacheUsage()
PUBLIC: Return the cache usage. |
java.util.Map<java.lang.Class,org.eclipse.persistence.internal.databaseaccess.DatabaseCall> |
getConcreteSubclassCalls()
INTERNAL: Return the cache of concrete subclass calls. |
short |
getDistinctState()
ADVANCED: If a distinct has been set the DISTINCT clause will be printed. |
java.lang.Object |
getExampleObject()
PUBLIC: This method returns the current example object. |
long |
getExecutionTime()
INTERNAL: Return the time this query actually went to the database |
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. |
java.util.Vector |
getFetchGroupSelectionFields(boolean isCustomSQL)
INTERNAL: Return the fields required in the select clause, for fetch group reading. |
InMemoryQueryIndirectionPolicy |
getInMemoryQueryIndirectionPolicy()
PUBLIC: Returns the InMemoryQueryIndirectionPolicy for this query |
int |
getInMemoryQueryIndirectionPolicyState()
PUBLIC: Returns the InMemoryQueryIndirectionPolicy for this query |
java.util.List |
getJoinedAttributeExpressions()
INTERNAL: Convience method for project mapping. |
org.eclipse.persistence.internal.queries.JoinedAttributeManager |
getJoinedAttributeManager()
INTERNAL: Return join manager responsible for managing all aspects of joining for the query. |
ClassDescriptor |
getLeafDescriptorFor(Expression expression,
ClassDescriptor rootDescriptor)
INTERNAL: Lookup the descriptor for this item by traversing its expression recursively. |
DatabaseMapping |
getLeafMappingFor(Expression expression,
ClassDescriptor rootDescriptor)
INTERNAL: Lookup the mapping for this item by traversing its expression recursively. |
org.eclipse.persistence.internal.expressions.ForUpdateClause |
getLockingClause()
INTERNAL: It is not exactly as simple as a query being either locking or not. |
short |
getLockMode()
PUBLIC: Return the current locking mode. |
java.util.Vector |
getNonFetchJoinAttributeExpressions()
INTERNAL: Return the attributes that must be joined, but not fetched, that is, do not trigger the value holder. |
java.util.Vector |
getPartialAttributeExpressions()
INTERNAL: Return the partial attributes to select. |
java.util.Vector |
getPartialAttributeSelectionFields(boolean isCustomSQL)
INTERNAL: Return the fields required in the select clause, for patial attribute reading. |
QueryByExamplePolicy |
getQueryByExamplePolicy()
PUBLIC: When using Query By Example, an instance of QueryByExamplePolicy is used to customize the query. |
java.lang.Class |
getReferenceClass()
PUBLIC: Return the reference class of the query. |
java.lang.String |
getReferenceClassName()
INTERNAL: Return the reference class of the query. |
java.util.Vector |
getSelectionFields()
INTERNAL: Return the fields selected by the query. |
boolean |
hasAdditionalFields()
INTERNAL: Return if additional field. |
boolean |
hasAsOfClause()
PUBLIC: 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. |
int |
hashCode()
INTERNAL: Compute a consistent hash-code for the expression. |
boolean |
hasJoining()
INTERNAL: Return if any attributes are joined. |
boolean |
hasNonFetchJoinedAttributeExpressions()
INTERNAL: Return the attributes that must be joined. |
boolean |
hasPartialAttributeExpressions()
INTERNAL: Return if partial attributes. |
protected void |
initializeDefaultBuilder()
Initialize the expression builder which should be used for this query. |
void |
initializeFetchGroup()
INTERNAL: Initialize fetch group |
boolean |
isClonePessimisticLocked(java.lang.Object clone,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
INTERNAL: Helper method that checks if clone has been locked with uow. |
boolean |
isDefaultLock()
INTERNAL: Helper method to determine the default mode. |
boolean |
isDefaultPropertiesQuery()
INTERNAL: Return true if the query uses default properties. |
boolean |
isDistinctComputed()
INTERNAL: return true if this query has computed its distinct value already |
boolean |
isFetchGroupAttribute(java.lang.String attributeName)
INTERNAL: Return if fetch group attribute. |
boolean |
isLockQuery()
PUBLIC: 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()
PUBLIC: Return if this is an object level read query. |
boolean |
isPartialAttribute(java.lang.String attributeName)
INTERNAL: Return if partial attribute. |
protected boolean |
isPrePrepared()
PUBLIC: Queries prepare common stated in themselves. |
boolean |
isReadOnly()
PUBLIC: Return if the query is read-only. |
protected boolean |
isReferenceClassLocked()
INTERNAL: Cache the locking policy isReferenceClassLocked check. |
protected boolean |
isRegisteringResults()
INTERNAL: Answers if we are executing through a UnitOfWork and registering results. |
boolean |
isResultSetOptimizedQuery()
ADVANCED: Return if the query should be optimized to build directly from the result set. |
protected void |
prepare()
INTERNAL: Prepare the receiver for execution in a session. |
protected void |
prepareForRemoteExecution()
INTERNAL: Prepare the receiver for execution in a session. |
protected boolean |
prepareFromCachedQuery()
INTERNAL: Check if the query is cached and prepare from it. |
void |
prepareFromQuery(DatabaseQuery query)
INTERNAL: Prepare the query from the prepared query. |
DatabaseQuery |
prepareOutsideUnitOfWork(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: There is a very special case where a query may be a bean-level pessimistic locking query. |
protected void |
prepareQuery()
INTERNAL: Prepare the receiver for execution in a session. |
protected void |
prePrepare()
INTERNAL: Prepare the receiver for execution in a session. |
void |
recordCloneForPessimisticLocking(java.lang.Object clone,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
INTERNAL: Helper method that records clone with uow if query is pessimistic locking. |
void |
refreshIdentityMapResult()
PUBLIC: Refresh the attributes of the object(s) resulting from the query. |
void |
refreshRemoteIdentityMapResult()
PUBLIC: Refresh the attributes of the object(s) resulting from the query. |
abstract java.lang.Object |
registerResultInUnitOfWork(java.lang.Object result,
org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork,
org.eclipse.persistence.internal.sessions.AbstractRecord arguments,
boolean buildDirectlyFromRows)
INTERNAL: All objects queried via a UnitOfWork get registered here. |
void |
resetDistinct()
ADVANCED: If a distinct has been set the DISTINCT clause will be printed. |
void |
setAdditionalFields(java.util.Vector additionalFields)
INTERNAL: Additional fields can be added to a query. |
void |
setAsOfClause(AsOfClause pastTime)
ADVANCED: Sets the query to execute as of the past time. |
void |
setCacheUsage(int cacheUsage)
PUBLIC: Set the cache usage. |
void |
setDescriptor(ClassDescriptor descriptor)
INTERNAL: Set the descriptor for the query. |
void |
setDistinctState(short distinctState)
ADVANCED: If a distinct has been set the DISTINCT clause will be printed. |
void |
setEJBQLString(java.lang.String ejbqlString)
PUBLIC: Set the EJBQL string of the query. |
void |
setExampleObject(java.lang.Object newExampleObject)
PUBLIC: Set the example object of the query to be the newExampleObject. |
void |
setExecutionTime(long executionTime)
INTERNAL: Set the the time this query went to the database. |
void |
setExpressionBuilder(ExpressionBuilder builder)
INTERNAL Sets the default expression builder for this query. |
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)
PUBLIC: Set the InMemoryQueryIndirectionPolicy for this query. |
void |
setInMemoryQueryIndirectionPolicyState(int inMemoryQueryIndirectionPolicy)
PUBLIC: Set the InMemoryQueryIndirectionPolicy for this query. |
void |
setIsPrepared(boolean isPrepared)
INTERNAL: Clear cached flags when un-preparing. |
protected void |
setIsPrePrepared(boolean isPrePrepared)
INTERNAL: If changes are made to the query that affect the derived SQL or Call parameters the query needs to be prepared again. |
void |
setIsReadOnly(boolean isReadOnly)
PUBLIC: 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 |
setJoinedAttributeExpressions(java.util.List expressions)
INTERNAL: Convience method for project mapping. |
void |
setJoinedAttributeManager(org.eclipse.persistence.internal.queries.JoinedAttributeManager joinedAttributeManager)
INTERNAL: Set join manager responsible for managing all aspects of joining for the query. |
void |
setLockingClause(org.eclipse.persistence.internal.expressions.ForUpdateClause clause)
INTERNAL: The locking clause contains a list of expressions representing which objects are to be locked by the query. |
void |
setLockMode(short lockMode)
PUBLIC: Sets whether this is a pessimistically locking query. |
protected void |
setNonFetchJoinAttributeExpressions(java.util.Vector nonFetchJoinExpressions)
INTERNAL: Return the attributes that must be joined, but not fetched, that is, do not trigger the value holder. |
void |
setPartialAttributeExpressions(java.util.Vector partialAttributeExpressions)
INTERNAL: Set the partial attributes to select. |
void |
setQueryByExamplePolicy(QueryByExamplePolicy queryByExamplePolicy)
PUBLIC: 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 |
setReferenceClassName(java.lang.String aClass)
INTERNAL: Set the reference class for the query. |
void |
setSelectionCriteria(Expression expression)
PUBLIC: To any user of this object. |
void |
setShouldFilterDuplicates(boolean shouldFilterDuplicates)
PUBLIC: Set if duplicate rows should be filter when using 1-m joining. |
void |
setShouldIncludeData(boolean shouldIncludeData)
INTERNAL: Set if the rows for the result of the query should also be returned using a complex query result. |
void |
setShouldOuterJoinSubclasses(boolean shouldOuterJoinSubclasses)
PUBLIC: Set if an outer join should be used to read subclasses. |
void |
setShouldProcessResultsInUnitOfWork(boolean processResultsInUnitOfWork)
ADVANCED: Used for CMP only. |
void |
setShouldRefreshIdentityMapResult(boolean shouldRefreshIdentityMapResult)
PUBLIC: Set if the attributes of the object(s) resulting from the query should be refreshed. |
void |
setShouldRefreshRemoteIdentityMapResult(boolean shouldRefreshIdentityMapResult)
PUBLIC: Set if the attributes of the object(s) resulting from the query should be refreshed. |
void |
setShouldRegisterResultsInUnitOfWork(boolean shouldRegisterResultsInUnitOfWork)
INTERNAL: Set to false to have queries conform to a UnitOfWork without registering any additional objects not already in that UnitOfWork. |
void |
setShouldUseDefaultFetchGroup(boolean shouldUseDefaultFetchGroup)
Set false if the user does not want to use the default fetch group defined in the descriptor level. |
protected void |
setWasDefaultLockMode(boolean wasDefaultLockMode)
INTERNAL: Set if this query originally used the default lock mode. |
boolean |
shouldCheckCacheOnly()
PUBLIC: Return if cache should be checked. |
boolean |
shouldCheckDescriptorForCacheUsage()
PUBLIC: Return whether the descriptor's disableCacheHits setting should be checked prior to querying the cache. |
boolean |
shouldConformResultsInUnitOfWork()
PUBLIC: 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 |
shouldDistinctBeUsed()
INTERNAL: return true if this query should use a distinct |
boolean |
shouldFilterDuplicates()
PUBLIC: Return if duplicate rows should be filter when using 1-m joining. |
boolean |
shouldIncludeData()
INTERNAL: Return if the rows for the result of the query should also be returned using a complex query result. |
boolean |
shouldOuterJoinSubclasses()
PUBLIC: Return if an outer join should be used to read subclasses. |
boolean |
shouldProcessResultsInUnitOfWork()
ADVANCED: Used for CMP only. |
boolean |
shouldReadAllMappings()
INTERNAL: Return if this is a full object query, not partial nor fetch group. |
boolean |
shouldReadMapping(DatabaseMapping mapping)
INTERNAL: Check if the mapping is part of the partial attributes. |
boolean |
shouldRefreshIdentityMapResult()
PUBLIC: Set to a boolean. |
boolean |
shouldRefreshRemoteIdentityMapResult()
PUBLIC: Set to a boolean. |
boolean |
shouldRegisterResultsInUnitOfWork()
INTERNAL: Allows one to do conforming in a UnitOfWork without registering. |
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. |
protected boolean |
wasDefaultLockMode()
INTERNAL: Return if this query originally used the default lock mode. |
Methods inherited from class org.eclipse.persistence.queries.ObjectBuildingQuery |
---|
convertClassNamesToClasses, getDataResults, isAttributeJoined, isObjectBuildingQuery, registerIndividualResult, setShouldBuildNullForNullPk, setShouldUseExclusiveConnection, shouldBuildNullForNullPk, shouldUseExclusiveConnection |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected ExpressionBuilder defaultBuilder
protected int cacheUsage
public static final int UseDescriptorSetting
public static final int DoNotCheckCache
public static final int CheckCacheByExactPrimaryKey
public static final int CheckCacheByPrimaryKey
public static final int CheckCacheThenDatabase
public static final int CheckCacheOnly
public static final int ConformResultsInUnitOfWork
protected java.util.Vector additionalFields
protected boolean shouldIncludeData
protected boolean isPrePrepared
protected short distinctState
public static final short UNCOMPUTED_DISTINCT
public static final short USE_DISTINCT
public static final short DONT_USE_DISTINCT
protected int inMemoryQueryIndirectionPolicy
protected long executionTime
protected FetchGroup fetchGroup
protected java.lang.String fetchGroupName
protected boolean shouldUseDefaultFetchGroup
protected java.util.Vector nonFetchJoinAttributeExpressions
protected java.util.Vector partialAttributeExpressions
protected org.eclipse.persistence.internal.queries.JoinedAttributeManager joinedAttributeManager
protected java.lang.Boolean isReferenceClassLocked
protected boolean isResultSetOptimizedQuery
protected boolean isReadOnly
protected java.lang.Boolean shouldOuterJoinSubclasses
protected java.util.Map<java.lang.Class,org.eclipse.persistence.internal.databaseaccess.DatabaseCall> concreteSubclassCalls
Constructor Detail |
---|
public ObjectLevelReadQuery()
Method Detail |
---|
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean isReadOnly()
public void setIsReadOnly(boolean isReadOnly)
protected boolean wasDefaultLockMode()
wasDefaultLockMode
in class ObjectBuildingQuery
protected void setWasDefaultLockMode(boolean wasDefaultLockMode)
setWasDefaultLockMode
in class ObjectBuildingQuery
public java.lang.Object clone()
clone
in class DatabaseQuery
public java.lang.Object deepClone()
Normally selection criteria are not cloned here as they are cloned later on during prepare.
deepClone
in class ObjectBuildingQuery
public void acquireLocks()
public void acquireLocksWithoutWaiting()
public void addAdditionalField(org.eclipse.persistence.internal.helper.DatabaseField field)
public void addAdditionalField(Expression fieldExpression)
public void addJoinedAttribute(java.lang.String attributeName)
Note: This cannot be used for objects where it is possible not to have a part, as these objects will be omitted 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")
addJoinedAttribute(Expression)
,
ReadAllQuery.addBatchReadAttribute(Expression)
public void addJoinedAttribute(Expression attributeExpression)
Note: This cannot be used for objects where it is possible not to have a part, as these objects will be omitted 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).
public void addNonFetchJoinedAttribute(java.lang.String attributeName)
Note: This cannot be used for objects where it is possible not to have a part, as these objects will be omitted from the result set, unless an outer join is used through passing and expression using "getAllowingNull".
Example: query.addNonFetchJoinedAttribute("address")
addNonFetchJoinedAttribute(Expression)
public void addNonFetchJoinedAttribute(Expression attributeExpression)
Note: This cannot be used for objects where it is possible not to have a part, as these objects will be omitted 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"))
addNonFetchJoinedAttribute(Expression)
public void addPartialAttribute(java.lang.String attributeName)
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")
addPartialAttribute(Expression)
protected void addSelectionFieldsForJoinedExpressions(java.util.List fields, java.util.List joinedExpressions)
public void setAsOfClause(AsOfClause pastTime)
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()
.
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.hasAsOfClause()
,
Session.acquireHistoricalSession(org.eclipse.persistence.history.AsOfClause)
,
Expression.asOf(org.eclipse.persistence.history.AsOfClause)
public void addPartialAttribute(Expression attributeExpression)
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"))
public java.lang.Object buildObject(org.eclipse.persistence.internal.sessions.AbstractRecord row)
buildObject
in class ReadQuery
public void checkCacheOnly()
setCacheUsage(int)
public void checkDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession session) throws QueryException
checkDescriptor
in class DatabaseQuery
QueryException
protected abstract java.lang.Object checkEarlyReturnImpl(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
public java.lang.Object checkEarlyReturn(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
checkEarlyReturn
in class DatabaseQuery
public void checkPrepare(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, boolean force)
checkPrepare
in class DatabaseQuery
protected void checkPrePrepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
public void changeDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession theSession)
protected java.lang.Object conformIndividualResult(java.lang.Object result, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractRecord arguments, Expression selectionCriteriaClone, java.util.Map alreadyReturned, boolean buildDirectlyFromRows)
A result needs to be registered before it can be conformed, so registerIndividualResult is called here.
Conforming on a result from the database is lenient. Since the object matched the query on the database we assume it matches here unless we can determine for sure that it was changed in this UnitOfWork not to conform.
result
- may be an original, or a raw database rowarguments
- the parameters this query was executed withselectionCriteriaClone
- the expression to conform to. If was a
selection object or key, null (which all conform to) is usedalreadyReturned
- a hashtable of objects already found by scanning
the UnitOfWork cache for conforming instances. Prevents duplicates.buildDirectlyFromRows
- whether result is an original or a raw database
row
public void conformResultsInUnitOfWork()
setCacheUsage(int)
public void dontAcquireLocks()
public void dontCheckCache()
public void dontRefreshIdentityMapResult()
dontRefreshIdentityMapResult
in class ObjectBuildingQuery
public void dontRefreshRemoteIdentityMapResult()
dontRefreshRemoteIdentityMapResult
in class ObjectBuildingQuery
public void dontUseDistinct()
public DatabaseQuery prepareOutsideUnitOfWork(org.eclipse.persistence.internal.sessions.AbstractSession session)
If that is so, only queries executed inside of a UnitOfWork should have a locking clause. In the extremely rare case that we execute a locking query outside of a UnitOfWork, must disable locking so that we do not get a fetch out of sequence error.
public java.lang.Object execute(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow) throws DatabaseException, OptimisticLockException
execute
in class DatabaseQuery
session
- - the session in which the receiver will be executed.
DatabaseException
- - an error has occurred on the database.
OptimisticLockException
- - an error has occurred using the optimistic lock feature.public java.lang.Object executeDatabaseQuery() throws DatabaseException
executeDatabaseQuery
in class DatabaseQuery
DatabaseException
- - an error has occurred on the database.protected abstract java.lang.Object executeObjectLevelReadQuery() throws DatabaseException
DatabaseException
protected abstract java.lang.Object executeObjectLevelReadQueryFromResultSet() throws DatabaseException
DatabaseException
public java.lang.Object executeInUnitOfWork(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow) throws DatabaseException, OptimisticLockException
executeInUnitOfWork
in class DatabaseQuery
unitOfWork
- - the session in which the receiver will be executed.translationRow
- - the arguments
DatabaseException
- - an error has occurred on the database.
OptimisticLockException
- - an error has occurred using the optimistic lock feature.public java.util.Vector getAdditionalFields()
public AsOfClause getAsOfClause()
null
if no clause set, AsOfClause.NO_CLAUSE
if
clause explicitly set to null
.AsOfClause
,
setAsOfClause(org.eclipse.persistence.history.AsOfClause)
,
hasAsOfClause()
public int getCacheUsage()
Valid values are:
public short getDistinctState()
public java.lang.Object getExampleObject()
public ExpressionBuilder getExpressionBuilder()
public void setExpressionBuilder(ExpressionBuilder builder)
public int getInMemoryQueryIndirectionPolicyState()
public InMemoryQueryIndirectionPolicy getInMemoryQueryIndirectionPolicy()
public org.eclipse.persistence.internal.queries.JoinedAttributeManager getJoinedAttributeManager()
public void setJoinedAttributeManager(org.eclipse.persistence.internal.queries.JoinedAttributeManager joinedAttributeManager)
public boolean hasJoining()
public java.util.List getJoinedAttributeExpressions()
public void setJoinedAttributeExpressions(java.util.List expressions)
public boolean shouldFilterDuplicates()
public void setShouldFilterDuplicates(boolean shouldFilterDuplicates)
public DatabaseMapping getLeafMappingFor(Expression expression, ClassDescriptor rootDescriptor) throws QueryException
QueryException
public ClassDescriptor getLeafDescriptorFor(Expression expression, ClassDescriptor rootDescriptor) throws QueryException
expression
- rootDescriptor
-
QueryException
public short getLockMode()
getLockMode
in class ObjectBuildingQuery
public org.eclipse.persistence.internal.expressions.ForUpdateClause getLockingClause()
public java.util.Vector getNonFetchJoinAttributeExpressions()
public java.util.Vector getPartialAttributeExpressions()
public long getExecutionTime()
getExecutionTime
in class ObjectBuildingQuery
public QueryByExamplePolicy getQueryByExamplePolicy()
public java.lang.Class getReferenceClass()
getReferenceClass
in class ObjectBuildingQuery
public java.lang.String getReferenceClassName()
getReferenceClassName
in class ObjectBuildingQuery
public boolean hasAsOfClause()
getAsOfClause()
public boolean hasNonFetchJoinedAttributeExpressions()
public boolean hasPartialAttributeExpressions()
hasPartialAttributeExpressions
in class ObjectBuildingQuery
public boolean hasAdditionalFields()
public java.util.Vector getPartialAttributeSelectionFields(boolean isCustomSQL)
public java.util.Vector getFetchGroupSelectionFields(boolean isCustomSQL)
public java.util.Vector getSelectionFields()
protected void initializeDefaultBuilder()
public boolean isDistinctComputed()
public boolean isLockQuery()
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.
isLockQuery
in class ObjectBuildingQuery
public boolean isLockQuery(Session session)
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.
isLockQuery()
public boolean isObjectLevelReadQuery()
isObjectLevelReadQuery
in class DatabaseQuery
public boolean isPartialAttribute(java.lang.String attributeName)
protected boolean isPrePrepared()
protected boolean isRegisteringResults()
isRegisteringResults
in class ObjectBuildingQuery
protected void setIsPrePrepared(boolean isPrePrepared)
Automatically called internally.
The early phase of preparation is to check if this is a pessimistic locking query.
public void setIsPrepared(boolean isPrepared)
setIsPrepared
in class DatabaseQuery
protected void prepare() throws QueryException
prepare
in class ReadQuery
QueryException
protected boolean prepareFromCachedQuery()
public void copyFromQuery(DatabaseQuery query)
copyFromQuery
in class ObjectBuildingQuery
public void prepareFromQuery(DatabaseQuery query)
prepareFromQuery
in class ObjectBuildingQuery
protected void prePrepare() throws QueryException
QueryException
protected void prepareQuery() throws QueryException
QueryException
protected void prepareForRemoteExecution() throws QueryException
prepareForRemoteExecution
in class DatabaseQuery
QueryException
public void refreshIdentityMapResult()
refreshIdentityMapResult
in class ObjectBuildingQuery
public void refreshRemoteIdentityMapResult()
refreshRemoteIdentityMapResult
in class ObjectBuildingQuery
public abstract java.lang.Object registerResultInUnitOfWork(java.lang.Object result, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractRecord arguments, boolean buildDirectlyFromRows)
Involves registering the query result individually and in totality, and hence refreshing / conforming is done here.
result
- may be collection (read all) or an object (read one),
or even a cursor. If in transaction the shared cache will
be bypassed, meaning the result may not be originals from the parent
but raw database rows.unitOfWork
- the unitOfWork the result is being registered in.arguments
- the original arguments/parameters passed to the query
execution. Used by conformingbuildDirectlyFromRows
- If in transaction must construct
a registered result from raw database rows.
public void resetDistinct()
public void setAdditionalFields(java.util.Vector additionalFields)
public void setCacheUsage(int cacheUsage)
Valid values are:
public void setDescriptor(ClassDescriptor descriptor)
setDescriptor
in class DatabaseQuery
public void setDistinctState(short distinctState)
public void setExecutionTime(long executionTime)
setExecutionTime
in class ObjectBuildingQuery
public void setExampleObject(java.lang.Object newExampleObject)
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).
public void setInMemoryQueryIndirectionPolicy(InMemoryQueryIndirectionPolicy inMemoryQueryIndirectionPolicy)
public void setInMemoryQueryIndirectionPolicyState(int inMemoryQueryIndirectionPolicy)
public void setLockMode(short lockMode)
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"));
setLockMode
in class ObjectBuildingQuery
PessimisticLockingPolicy
protected void setNonFetchJoinAttributeExpressions(java.util.Vector nonFetchJoinExpressions)
public void setLockingClause(org.eclipse.persistence.internal.expressions.ForUpdateClause clause)
Use for even finer grained control over what is and is not locked by a particular query.
public void setPartialAttributeExpressions(java.util.Vector partialAttributeExpressions)
public void setEJBQLString(java.lang.String ejbqlString)
DatabaseQuery
setEJBQLString
in class DatabaseQuery
public void setQueryByExamplePolicy(QueryByExamplePolicy queryByExamplePolicy)
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).
public void setReferenceClass(java.lang.Class aClass)
setReferenceClass
in class ObjectBuildingQuery
public void setReferenceClassName(java.lang.String aClass)
setReferenceClassName
in class ObjectBuildingQuery
public void setSelectionCriteria(Expression expression)
DatabaseQuery
setSelectionCriteria
in class DatabaseQuery
public void setShouldIncludeData(boolean shouldIncludeData)
ComplexQueryResult
public void setShouldRefreshIdentityMapResult(boolean shouldRefreshIdentityMapResult)
setShouldRefreshIdentityMapResult
in class ObjectBuildingQuery
public void setShouldRefreshRemoteIdentityMapResult(boolean shouldRefreshIdentityMapResult)
setShouldRefreshRemoteIdentityMapResult
in class ObjectBuildingQuery
public void setShouldRegisterResultsInUnitOfWork(boolean shouldRegisterResultsInUnitOfWork)
setShouldRegisterResultsInUnitOfWork
in class ObjectBuildingQuery
shouldRegisterResultsInUnitOfWork()
public boolean shouldCheckCacheOnly()
public boolean shouldCheckDescriptorForCacheUsage()
public boolean shouldConformResultsInUnitOfWork()
public boolean shouldDistinctBeUsed()
public boolean shouldIncludeData()
ComplexQueryResult
public boolean shouldOuterJoinSubclasses()
public void setShouldOuterJoinSubclasses(boolean shouldOuterJoinSubclasses)
public boolean shouldRegisterResultsInUnitOfWork()
Extreme care should be taken in using this feature, for a user will get back a mix of registered and original (unregistered) objects.
Best used with a WrapperPolicy where invoking on an object will trigger
its registration (CMP). Without a WrapperPolicy registerExistingObject
should be called on any object that you intend to change.
shouldRegisterResultsInUnitOfWork
in class ObjectBuildingQuery
setShouldRegisterResultsInUnitOfWork(boolean)
,
ClassDescriptor.shouldRegisterResultsInUnitOfWork()
public boolean shouldReadAllMappings()
shouldReadAllMappings
in class ObjectBuildingQuery
public boolean shouldReadMapping(DatabaseMapping mapping)
shouldReadMapping
in class ObjectBuildingQuery
public boolean shouldRefreshIdentityMapResult()
shouldRefreshIdentityMapResult
in class ObjectBuildingQuery
public boolean shouldRefreshRemoteIdentityMapResult()
shouldRefreshRemoteIdentityMapResult
in class ObjectBuildingQuery
public java.lang.String toString()
toString
in class ObjectBuildingQuery
public void setShouldProcessResultsInUnitOfWork(boolean processResultsInUnitOfWork)
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.
setShouldProcessResultsInUnitOfWork
in class ObjectBuildingQuery
public boolean shouldProcessResultsInUnitOfWork()
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.
shouldProcessResultsInUnitOfWork
in class ObjectBuildingQuery
public void useDistinct()
public boolean isClonePessimisticLocked(java.lang.Object clone, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
isClonePessimisticLocked
in class ObjectBuildingQuery
protected boolean isReferenceClassLocked()
public void recordCloneForPessimisticLocking(java.lang.Object clone, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
recordCloneForPessimisticLocking
in class ObjectBuildingQuery
public boolean isResultSetOptimizedQuery()
public void setIsResultSetOptimizedQuery(boolean isResultSetOptimizedQuery)
public boolean isDefaultLock()
isDefaultLock
in class ObjectBuildingQuery
public boolean isDefaultPropertiesQuery()
isDefaultPropertiesQuery
in class ReadQuery
public boolean hasFetchGroup()
public FetchGroup getFetchGroup()
getFetchGroup
in class ObjectBuildingQuery
public void initializeFetchGroup()
public void setFetchGroup(FetchGroup newFetchGroup)
public void setFetchGroupName(java.lang.String groupName)
public java.lang.String getFetchGroupName()
public boolean shouldUseDefaultFetchGroup()
public void setShouldUseDefaultFetchGroup(boolean shouldUseDefaultFetchGroup)
public boolean isFetchGroupAttribute(java.lang.String attributeName)
public java.util.Map<java.lang.Class,org.eclipse.persistence.internal.databaseaccess.DatabaseCall> getConcreteSubclassCalls()
|
EclipseLink1.0 - 20080707 API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |