Class ReadObjectQuery
- java.lang.Object
-
- org.eclipse.persistence.queries.DatabaseQuery
-
- org.eclipse.persistence.queries.ReadQuery
-
- org.eclipse.persistence.queries.ObjectBuildingQuery
-
- org.eclipse.persistence.queries.ObjectLevelReadQuery
-
- org.eclipse.persistence.queries.ReadObjectQuery
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable
public class ReadObjectQuery extends ObjectLevelReadQuery
Purpose: Concrete class for all read queries involving a single object.
Responsibilities: Return a single object for the query. Implements the inheritance feature when dealing with abstract descriptors.
- See Also:
- Serialized Form
- Author:
- Yvon Lavoie
- Since:
- TOPLink/Java 1.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.eclipse.persistence.queries.DatabaseQuery
DatabaseQuery.ParameterType
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.ObjectselectionIdKey that can be used in place of a selection criteria.protected java.lang.ObjectselectionObjectObject that can be used in place of a selection criteria.protected booleanshouldLoadResultIntoSelectionObjectCan be used to refresh a specific non-cached instance from the database.-
Fields inherited from class org.eclipse.persistence.queries.ObjectLevelReadQuery
additionalFields, aggregateQueries, batchFetchPolicy, cacheUsage, CheckCacheByExactPrimaryKey, CheckCacheByPrimaryKey, CheckCacheOnly, CheckCacheThenDatabase, concreteSubclassCalls, concreteSubclassJoinedMappingIndexes, concreteSubclassQueries, ConformResultsInUnitOfWork, defaultBuilder, distinctState, DoNotCheckCache, DONT_USE_DISTINCT, fetchGroup, fetchGroupName, inMemoryQueryIndirectionPolicy, isCachedExpressionQuery, isPrePrepared, isReadOnly, isReferenceClassLocked, isResultSetAccessOptimizedQuery, isResultSetAccessOptimizedQueryDefault, isResultSetOptimizedQuery, joinedAttributeManager, loadGroup, lockModeType, NONE, nonFetchJoinAttributeExpressions, OPTIMISTIC, OPTIMISTIC_FORCE_INCREMENT, orderByExpressions, partialAttributeExpressions, PESSIMISTIC_, PESSIMISTIC_FORCE_INCREMENT, PESSIMISTIC_READ, PESSIMISTIC_WRITE, READ, shouldExtendPessimisticLockScope, shouldIncludeData, shouldOuterJoinSubclasses, shouldUseDefaultFetchGroup, shouldUseSerializedObjectPolicy, shouldUseSerializedObjectPolicyDefault, UNCOMPUTED_DISTINCT, unionExpressions, USE_DISTINCT, UseDescriptorSetting, usesResultSetAccessOptimization, waitTimeout, waitTimeoutUnit, WRITE
-
Fields inherited from class org.eclipse.persistence.queries.ObjectBuildingQuery
DEFAULT_LOCK_MODE, executionTime, isCacheCheckComplete, LOCK, LOCK_NOWAIT, LOCK_RESULT_PROPERTY, lockingClause, NO_LOCK, prefetchedCacheKeys, printInnerJoinInWhereClause, referenceClass, referenceClassName, requiresDeferredLocks, shouldBuildNullForNullPk, shouldRefreshIdentityMapResult, shouldRefreshRemoteIdentityMapResult, shouldRegisterResultsInUnitOfWork, shouldUseExclusiveConnection, wasDefaultLockMode
-
Fields inherited from class org.eclipse.persistence.queries.ReadQuery
allowQueryResultsCacheValidation, fetchSize, firstResult, maxResults, maxRows, queryId, queryResultCachingPolicy, temporaryCachedQueryResults
-
Fields inherited from class org.eclipse.persistence.queries.DatabaseQuery
accessors, allowNativeSQLQuery, argumentFields, argumentParameterTypes, arguments, argumentTypeNames, argumentTypes, argumentValues, BATCH_FETCH_PROPERTY, CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, cascadePolicy, CascadePrivateParts, descriptor, descriptors, doNotRedirect, executionSession, flushOnExecute, hintString, isCustomQueryUsed, isExecutionClone, isNativeConnectionRequired, isPrepared, isUserDefined, isUserDefinedSQLCall, monitorName, name, NoCascading, nullableArguments, parameterDelimiter, partitioningPolicy, properties, queryMechanism, queryTimeout, queryTimeoutUnit, redirector, session, sessionName, shouldBindAllParameters, shouldCacheStatement, shouldCloneCall, shouldMaintainCache, shouldPrepare, shouldRetrieveBypassCache, shouldReturnGeneratedKeys, shouldStoreBypassCache, shouldUseWrapperPolicy, shouldValidateUpdateCallCacheUse, sourceMapping, translationRow
-
-
Constructor Summary
Constructors Constructor Description ReadObjectQuery()PUBLIC: Return a new read object query.ReadObjectQuery(java.lang.Class classToRead)PUBLIC: Return a new read object query.ReadObjectQuery(java.lang.Class classToRead, Expression selectionCriteria)PUBLIC: Return a new read object query for the class and the selection criteria.ReadObjectQuery(java.lang.Class classToRead, ExpressionBuilder builder)PUBLIC: Return a new read object query for the class.ReadObjectQuery(java.lang.Class classToRead, Call call)PUBLIC: Return a new read object query.ReadObjectQuery(java.lang.Object objectToRead)PUBLIC: Return a query to read the object with the same primary key as the provided object.ReadObjectQuery(java.lang.Object exampleObject, QueryByExamplePolicy policy)PUBLIC: Return a query by example query to find an object matching the attributes of the example object.ReadObjectQuery(ExpressionBuilder builder)PUBLIC: The expression builder should be provide on creation to ensure only one is used.ReadObjectQuery(Call call)PUBLIC: Return a new read object query.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidcacheResult(java.lang.Object object)INTERNAL:voidcheckCacheByExactPrimaryKey()PUBLIC: The cache will be checked only if the query contains exactly the primary key.voidcheckCacheByPrimaryKey()PUBLIC: This is the default, the cache will be checked only if the query contains the primary key.voidcheckCacheThenDatabase()PUBLIC: The cache will be checked completely, then if the object is not found or the query too complex the database will be queried.protected java.lang.BooleancheckCustomQueryFlag(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)INTERNAL: Check and return custom query flag.voidcheckDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Ensure that the descriptor has been set.protected java.lang.ObjectcheckEarlyReturnLocal(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)INTERNAL: The cache check is done before the prepare as a hit will not require the work to be done.voidclearSelectionId()INTERNAL: Clear the selection id and object.protected java.lang.ObjectconformResult(java.lang.Object result, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, boolean buildDirectlyFromRows)INTERNAL: Conform the result in the UnitOfWork.voidcopyFromQuery(DatabaseQuery query)INTERNAL: Copy all setting from the query.voiddontLoadResultIntoSelectionObject()PUBLIC: Do not refesh/load into the selection object, this is the default.java.lang.Objectexecute(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord row)INTERNAL: Execute the query.protected java.lang.ObjectexecuteObjectLevelReadQuery()INTERNAL: Execute the query.protected java.lang.ObjectexecuteObjectLevelReadQueryFromResultSet()INTERNAL: Execute the query building the objects directly from the database result-set.java.lang.ObjectextractRemoteResult(org.eclipse.persistence.internal.sessions.remote.Transporter transporter)INTERNAL: Extract the correct query result from the transporter.protected QueryRedirectorgetDefaultRedirector()INTERNAL: Returns the specific default redirector for this query type.protected java.lang.ObjectgetQueryPrimaryKey()INTERNAL: Return the primary key stored in this queryprotected ObjectLevelReadQuerygetReadQuery()INTERNAL: Get custom single object read query from query manager.java.lang.ObjectgetSelectionId()PUBLIC: Return Id of the object to be selected by the query.java.util.VectorgetSelectionKey()Deprecated.since EclipseLink 2.1, replaced by getSelectionId()java.lang.ObjectgetSelectionObject()PUBLIC: Return the selection object of the query.protected booleanhasNonDefaultFetchGroup()INTERNAL: Return if the query has an non-default fetch group defined for itself.booleanisPrimaryKeyQuery()INTERNAL: Return if the query is by primary key.booleanisReadObjectQuery()PUBLIC: Return if this is a read object query.voidloadResultIntoSelectionObject()PUBLIC: Allow for the selection object of the query to be refreshed or put into the EclipseLink cache.protected voidprepare()INTERNAL: Prepare the receiver for execution in a session.protected voidprepareCustomQuery(DatabaseQuery customQuery)INTERNAL: Set the properties needed to be cascaded into the custom query including the translation row.voidprepareForExecution()INTERNAL: Prepare the receiver for execution in a session.protected voidprePrepare()INTERNAL: Prepare the receiver for execution in a session.java.lang.ObjectregisterResultInUnitOfWork(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.protected java.lang.ObjectremoteExecute()java.util.MapreplaceValueHoldersIn(java.lang.Object object, org.eclipse.persistence.internal.sessions.remote.RemoteSessionController controller)INTERNAL: replace the value holders in the specified result object(s)voidsetSelectionId(java.lang.Object id)PUBLIC: The Id of the object to be selected by the query.voidsetSelectionKey(java.util.List selectionKey)Deprecated.since EclipseLink 2.1, replaced by setSelectionId(Object)voidsetSelectionObject(java.lang.Object selectionObject)PUBLIC: Used to set the where clause of the query.voidsetShouldLoadResultIntoSelectionObject(boolean shouldLoadResultIntoSelectionObject)PUBLIC: Allow for the selection object of the query to be refreshed or put into the EclipseLink cache.voidsetSingletonSelectionKey(java.lang.Object selectionKey)Deprecated.since EclipseLink 2.1, replaced by setSelectionId(Object)booleanshouldCheckCacheByExactPrimaryKey()PUBLIC: Return if cache should be checked.booleanshouldCheckCacheByPrimaryKey()PUBLIC: Return if cache should be checked.booleanshouldCheckCacheThenDatabase()PUBLIC: Return if cache should be checked.booleanshouldLoadResultIntoSelectionObject()PUBLIC: return true if the result should be loaded into the passed in selection Object-
Methods inherited from class org.eclipse.persistence.queries.ObjectLevelReadQuery
acquireLocks, acquireLocksWithoutWaiting, addAdditionalField, addAdditionalField, addBatchReadAttribute, addBatchReadAttribute, addDescendingOrdering, addJoinedAttribute, addJoinedAttribute, addJoinSelectionFields, addNonFetchJoin, addNonFetchJoinedAttribute, addNonFetchJoinedAttribute, addOrdering, addPartialAttribute, addPartialAttribute, addSelectionFieldsForJoinedExpression, addUnionExpression, buildObject, changeDescriptor, checkCacheOnly, checkEarlyReturn, checkForCustomQuery, checkPrepare, checkPrePrepare, clearIsResultSetOptimizedQuery, clearUsesResultSetAccessOptimization, clone, computeBatchReadAttributes, computeBatchReadMappingQueries, computeNestedQueriesForBatchReadExpressions, conformIndividualResult, conformResultsInUnitOfWork, deepClone, dontAcquireLocks, dontCheckCache, dontRefreshIdentityMapResult, dontRefreshRemoteIdentityMapResult, dontUseDistinct, equals, except, executeDatabaseQuery, executeInUnitOfWork, extendPessimisticLockScope, getAdditionalFields, getAggregateQueries, getAggregateQuery, getAsOfClause, getBatchFetchPolicy, getBatchObjects, getBatchReadAttributeExpressions, getCacheUsage, getConcreteSubclassCalls, getConcreteSubclassJoinedMappingIndexes, getConcreteSubclassQueries, getDistinctState, getExampleObject, getExecutionFetchGroup, getExecutionFetchGroup, getExpressionBuilder, getFetchGroup, getFetchGroupName, getFetchGroupNonNestedFieldsSet, getFetchGroupNonNestedFieldsSet, getFetchGroupSelectionFields, getFetchGroupSelectionFields, getInMemoryQueryIndirectionPolicy, getInMemoryQueryIndirectionPolicyState, getJoinedAttributeExpressions, getJoinedAttributeManager, getLoadGroup, getLockingClause, getLockModeType, getNonFetchJoinAttributeExpressions, getOrderByExpressions, getPartialAttributeExpressions, getPartialAttributeSelectionFields, getQueryByExamplePolicy, getReferenceClass, getReferenceClassName, getSelectionFields, getUnionExpressions, getWaitTimeout, getWaitTimeoutUnit, hasAdditionalFields, hasAsOfClause, hasBatchReadAttributes, hasDefaultBuilder, hasExecutionFetchGroup, hasFetchGroup, hashCode, hasJoining, hasNonFetchJoinedAttributeExpressions, hasOrderByExpressions, hasPartialAttributeExpressions, hasUnionExpressions, initializeDefaultBuilder, intersect, isAttributeBatchRead, isCachedExpressionQuery, isClonePessimisticLocked, isDefaultLock, isDefaultPropertiesQuery, isDistinctComputed, isLockQuery, isLockQuery, isObjectLevelReadQuery, isPartialAttribute, isPrePrepared, isReadOnly, isReferenceClassLocked, isResultSetAccessOptimizedQuery, isResultSetOptimizedQuery, prepareFetchGroup, prepareForRemoteExecution, prepareFromCachedQuery, prepareFromQuery, prepareOutsideUnitOfWork, prepareQuery, prepareResultSetAccessOptimization, recordCloneForPessimisticLocking, refreshIdentityMapResult, refreshRemoteIdentityMapResult, resetDistinct, setAdditionalFields, setAggregateQuery, setAsOfClause, setBatchFetchPolicy, setBatchFetchSize, setBatchFetchType, setBatchObjects, setBatchReadAttributeExpressions, setCacheUsage, setDescriptor, setDistinctState, setEJBQLString, setExampleObject, setExpressionBuilder, setFetchGroup, setFetchGroupName, setInMemoryQueryIndirectionPolicy, setInMemoryQueryIndirectionPolicyState, setIsPrepared, setIsPreparedKeepingSubclassData, setIsPrePrepared, setIsReadOnly, setIsResultSetAccessOptimizedQuery, setIsResultSetOptimizedQuery, setJoinedAttributeExpressions, setJoinedAttributeManager, setLoadGroup, setLockingClause, setLockMode, setLockModeType, setNonFetchJoinAttributeExpressions, setOrderByExpressions, setPartialAttributeExpressions, setQueryByExamplePolicy, setReferenceClass, setReferenceClassName, setSelectionCriteria, setShouldExtendPessimisticLockScope, setShouldFilterDuplicates, setShouldIncludeData, setShouldOuterJoinSubclasses, setShouldUseDefaultFetchGroup, setShouldUseSerializedObjectPolicy, setUnionExpressions, setWaitTimeout, setWaitTimeoutUnit, shouldCheckCache, shouldCheckCacheOnly, shouldCheckDescriptorForCacheUsage, shouldConformResultsInUnitOfWork, shouldDistinctBeUsed, shouldExtendPessimisticLockScope, shouldFilterDuplicates, shouldIncludeData, shouldOuterJoinSubclasses, shouldReadAllMappings, shouldReadMapping, shouldUseDefaultFetchGroup, shouldUseSerializedObjectPolicy, supportsResultSetAccessOptimizationOnExecute, supportsResultSetAccessOptimizationOnPrepare, toString, union, useDistinct, usesResultSetAccessOptimization
-
Methods inherited from class org.eclipse.persistence.queries.ObjectBuildingQuery
clonedQueryExecutionComplete, convertClassNamesToClasses, getDataResults, getExecutionTime, getLockMode, getPrefetchedCacheKeys, isAttributeJoined, isCacheCheckComplete, isObjectBuildingQuery, isRegisteringResults, postRegisterIndividualResult, printInnerJoinInWhereClause, registerIndividualResult, requiresDeferredLocks, setExecutionTime, setPrefetchedCacheKeys, setPrintInnerJoinInWhereClause, setRequiresDeferredLocks, setShouldBuildNullForNullPk, setShouldRefreshIdentityMapResult, setShouldRefreshRemoteIdentityMapResult, setShouldRegisterResultsInUnitOfWork, setShouldUseExclusiveConnection, setWasDefaultLockMode, shouldBuildNullForNullPk, shouldRefreshIdentityMapResult, shouldRefreshRemoteIdentityMapResult, shouldRegisterResultsInUnitOfWork, shouldUseExclusiveConnection, wasDefaultLockMode
-
Methods inherited from class org.eclipse.persistence.queries.ReadQuery
cacheQueryResults, clearQueryResults, doNotCacheQueryResults, getFetchSize, getFirstResult, getInternalMax, getMaxRows, getQueryId, getQueryResults, getQueryResults, getQueryResults, getQueryResultsCachePolicy, getTemporaryCachedQueryResults, isReadQuery, remoteExecute, setAllowQueryResultsCacheValidation, setFetchSize, setFirstResult, setInternalMax, setMaxRows, setQueryId, setQueryResults, setQueryResultsCachePolicy, setTemporaryCachedQueryResults, shouldAllowQueryResultsCacheValidation, shouldCacheQueryResults
-
Methods inherited from class org.eclipse.persistence.queries.DatabaseQuery
addArgument, addArgument, addArgument, addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildArgumentFields, buildSelectionCriteria, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkPrepare, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, getAccessor, getAccessors, getArgumentParameterTypes, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDescriptor, getDescriptors, getDomainClassNounName, getDoNotRedirect, getEJBQLString, getExecutionSession, getFlushOnExecute, getHintString, getJPQLString, getMonitorName, getName, getNullableArguments, getParameterDelimiter, getParameterDelimiterChar, getPartitioningPolicy, getProperties, getProperty, getQueryMechanism, getQueryNounName, getQueryTimeout, getQueryTimeoutUnit, getRedirector, getRedirectorForQuery, getSelectionCriteria, getSensorName, getSession, getSessionName, getShouldBindAllParameters, getSourceMapping, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasArguments, hasNullableArguments, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isCustomQueryUsed, isCustomSelectionQuery, isDataModifyQuery, isDataReadQuery, isDeleteAllQuery, isDeleteObjectQuery, isDirectReadQuery, isExecutionClone, isExpressionQuery, isInsertObjectQuery, isJPQLCallQuery, isModifyAllQuery, isModifyQuery, isNativeConnectionRequired, isObjectLevelModifyQuery, isPrepared, isReadAllQuery, isReportQuery, isResultSetMappingQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, isUserDefinedSQLCall, isValueReadQuery, isWriteObjectQuery, maintainCache, prepareCall, prepareInternal, redirectQuery, removeProperty, resetMonitorName, retrieveBypassCache, rowFromArguments, setAccessor, setAccessors, setAllowNativeSQLQuery, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setCall, setCascadePolicy, setDatasourceCall, setDoNotRedirect, setExecutionSession, setFlushOnExecute, setHintString, setIsCustomQueryUsed, setIsExecutionClone, setIsNativeConnectionRequired, setIsUserDefined, setIsUserDefinedSQLCall, setJPQLString, setName, setNullableArguments, setParameterDelimiter, setPartitioningPolicy, setProperties, setProperty, setQueryMechanism, setQueryTimeout, setQueryTimeoutUnit, setRedirector, setSession, setSessionName, setShouldBindAllParameters, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldRetrieveBypassCache, setShouldReturnGeneratedKeys, setShouldStoreBypassCache, setShouldUseWrapperPolicy, setShouldValidateUpdateCallCacheUse, setSourceMapping, setSQLStatement, setSQLString, setTranslationRow, shouldAllowNativeSQLQuery, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldCloneCall, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldPrepare, shouldRetrieveBypassCache, shouldReturnGeneratedKeys, shouldStoreBypassCache, shouldUseWrapperPolicy, shouldValidateUpdateCallCacheUse, storeBypassCache
-
-
-
-
Field Detail
-
selectionObject
protected transient java.lang.Object selectionObject
Object that can be used in place of a selection criteria.
-
selectionId
protected java.lang.Object selectionId
Key that can be used in place of a selection criteria.
-
shouldLoadResultIntoSelectionObject
protected boolean shouldLoadResultIntoSelectionObject
Can be used to refresh a specific non-cached instance from the database.
-
-
Constructor Detail
-
ReadObjectQuery
public ReadObjectQuery()
PUBLIC: Return a new read object query. A reference class must be specified before execution. It is better to provide the class and expression builder on construction to esnure a single expression builder is used. If no selection criteria is specified this will reads the first object found in the database.
-
ReadObjectQuery
public ReadObjectQuery(java.lang.Class classToRead)
PUBLIC: Return a new read object query. By default, the query has no selection criteria. Executing this query without selection criteria will always result in a database access to read the first instance of the specified Class found in the database. This is true no matter how cache usage is configured and even if an instance of the specified Class exists in the cache. Executing a query with selection criteria allows you to avoid a database access if the selected instance is in the cache. For this reason, you may whish to use a ReadObjectQuery constructor that takes selection criteria, such as:ReadObjectQuery(Class, Call),ReadObjectQuery(Class, Expression),ReadObjectQuery(Class, ExpressionBuilder),ReadObjectQuery(ExpressionBuilder),ReadObjectQuery(Object), orReadObjectQuery(Object, QueryByExamplePolicy).
-
ReadObjectQuery
public ReadObjectQuery(java.lang.Class classToRead, Expression selectionCriteria)PUBLIC: Return a new read object query for the class and the selection criteria.
-
ReadObjectQuery
public ReadObjectQuery(java.lang.Class classToRead, ExpressionBuilder builder)PUBLIC: Return a new read object query for the class. The expression builder must be used for all associated expressions used with the query.
-
ReadObjectQuery
public ReadObjectQuery(java.lang.Class classToRead, Call call)PUBLIC: Return a new read object query. The call represents a database interaction such as SQL, Stored Procedure.
-
ReadObjectQuery
public ReadObjectQuery(Call call)
PUBLIC: Return a new read object query. The call represents a database interaction such as SQL, Stored Procedure.
-
ReadObjectQuery
public ReadObjectQuery(java.lang.Object objectToRead)
PUBLIC: Return a query to read the object with the same primary key as the provided object. Note: This is not a query by example object, only the primary key will be used for the selection criteria.
-
ReadObjectQuery
public ReadObjectQuery(java.lang.Object exampleObject, QueryByExamplePolicy policy)PUBLIC: Return a query by example query to find an object matching the attributes of the example object.
-
ReadObjectQuery
public ReadObjectQuery(ExpressionBuilder builder)
PUBLIC: The expression builder should be provide on creation to ensure only one is used.
-
-
Method Detail
-
cacheResult
public void cacheResult(java.lang.Object object)
INTERNAL:This method is called by the object builder when building an original. It will cause the original to be cached in the query results if the query is set to do so.
- Specified by:
cacheResultin classReadQuery
-
checkCacheByExactPrimaryKey
public void checkCacheByExactPrimaryKey()
PUBLIC: The cache will be checked only if the query contains exactly the primary key. Queries can be configured to use the cache at several levels. Other caching option are available.- See Also:
ObjectLevelReadQuery.setCacheUsage(int)
-
checkCacheByPrimaryKey
public void checkCacheByPrimaryKey()
PUBLIC: This is the default, the cache will be checked only if the query contains the primary key. Queries can be configured to use the cache at several levels. Other caching option are available.- See Also:
ObjectLevelReadQuery.setCacheUsage(int)
-
checkCacheThenDatabase
public void checkCacheThenDatabase()
PUBLIC: The cache will be checked completely, then if the object is not found or the query too complex the database will be queried. Queries can be configured to use the cache at several levels. Other caching option are available.- See Also:
ObjectLevelReadQuery.setCacheUsage(int)
-
checkDescriptor
public void checkDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession session) throws QueryExceptionINTERNAL: Ensure that the descriptor has been set.- Overrides:
checkDescriptorin classObjectLevelReadQuery- Parameters:
session- Current session.- Throws:
QueryException
-
checkEarlyReturnLocal
protected java.lang.Object checkEarlyReturnLocal(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)INTERNAL: The cache check is done before the prepare as a hit will not require the work to be done.- Specified by:
checkEarlyReturnLocalin classObjectLevelReadQuery
-
checkCustomQueryFlag
protected java.lang.Boolean checkCustomQueryFlag(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)INTERNAL: Check and return custom query flag. Custom query flag value is initialized when stored value isnull. Called fromObjectLevelReadQuery.checkForCustomQuery(AbstractSession, AbstractRecord)to retrieve custom query flag.- Specified by:
checkCustomQueryFlagin classObjectLevelReadQuery- Parameters:
session- Current session.translationRow- Database record.- Returns:
- Current custom query flag. Value will never be
null.
-
getReadQuery
protected ObjectLevelReadQuery getReadQuery()
INTERNAL: Get custom single object read query from query manager. Called fromObjectLevelReadQuery.checkForCustomQuery(AbstractSession, AbstractRecord)to retrieve custom read query.- Specified by:
getReadQueryin classObjectLevelReadQuery- Returns:
- Custom single object read query from query manager.
-
conformResult
protected java.lang.Object conformResult(java.lang.Object result, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, boolean buildDirectlyFromRows)INTERNAL: Conform the result in the UnitOfWork.
-
dontLoadResultIntoSelectionObject
public void dontLoadResultIntoSelectionObject()
PUBLIC: Do not refesh/load into the selection object, this is the default. This property allows for the selection object of the query to be refreshed or put into the TopLink cache. By default on a read or refresh the object in the cache is refreshed and returned or a new object is built from the database, in some cases such as EJB BMP it is desirable to refresh or load into the object passed into the read object query.Note: This forces the selection object into the cache a replaces any existing object that may already be there, this is a strict violation of object identity and other objects can still be refering to the old object.
-
execute
public java.lang.Object execute(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord row) throws DatabaseExceptionINTERNAL: Execute the query. If there are cached results return those. This must override the super to support result caching.- Overrides:
executein classObjectLevelReadQuery- Parameters:
session- the session in which the receiver will be executed.- Returns:
- An object or vector, the result of executing the query.
- Throws:
DatabaseException- - an error has occurred on the database
-
executeObjectLevelReadQuery
protected java.lang.Object executeObjectLevelReadQuery() throws DatabaseExceptionINTERNAL: Execute the query. Do a cache lookup and build object from row if required.- Specified by:
executeObjectLevelReadQueryin classObjectLevelReadQuery- Returns:
- object - the first object found or null if none.
- Throws:
DatabaseException- - an error has occurred on the database
-
executeObjectLevelReadQueryFromResultSet
protected java.lang.Object executeObjectLevelReadQueryFromResultSet() throws DatabaseExceptionINTERNAL: Execute the query building the objects directly from the database result-set.- Specified by:
executeObjectLevelReadQueryFromResultSetin classObjectLevelReadQuery- Returns:
- object - the first object found or null if none.
- Throws:
DatabaseException- - an error has occurred on the database
-
extractRemoteResult
public java.lang.Object extractRemoteResult(org.eclipse.persistence.internal.sessions.remote.Transporter transporter)
INTERNAL: Extract the correct query result from the transporter.- Overrides:
extractRemoteResultin classDatabaseQuery
-
getDefaultRedirector
protected QueryRedirector getDefaultRedirector()
INTERNAL: Returns the specific default redirector for this query type. There are numerous default query redirectors. See ClassDescriptor for their types.- Overrides:
getDefaultRedirectorin classDatabaseQuery
-
getSelectionKey
@Deprecated public java.util.Vector getSelectionKey()
Deprecated.since EclipseLink 2.1, replaced by getSelectionId()PUBLIC: The primary key can be specified if used instead of an expression or selection object. If composite the primary must be in the same order as defined in the descriptor.- See Also:
getSelectionId()
-
getSelectionObject
public java.lang.Object getSelectionObject()
PUBLIC: Return the selection object of the query. This can be used instead of a where clause expression for single object primary key queries. The selection object given should have a primary key defined, this primary key will be used to query the database instance of the same object. This is a basic form of query by example where only the primary key is required, it can be used for simple query forms, or testing.
-
isReadObjectQuery
public boolean isReadObjectQuery()
PUBLIC: Return if this is a read object query.- Overrides:
isReadObjectQueryin classDatabaseQuery
-
isPrimaryKeyQuery
public boolean isPrimaryKeyQuery()
INTERNAL: Return if the query is by primary key.- Overrides:
isPrimaryKeyQueryin classObjectLevelReadQuery
-
loadResultIntoSelectionObject
public void loadResultIntoSelectionObject()
PUBLIC: Allow for the selection object of the query to be refreshed or put into the EclipseLink cache. By default on a read or refresh the object in the cache is refreshed and returned or a new object is built from the database, in some cases such as EJB BMP it is desirable to refresh or load into the object passed into the read object query.Note: This forces the selection object into the cache a replaces any existing object that may already be there, this is a strict violation of object identity and other objects can still be referring to the old object.
-
copyFromQuery
public void copyFromQuery(DatabaseQuery query)
INTERNAL: Copy all setting from the query. This is used to morph queries from one type to the other. By default this calls prepareFromQuery, but additional properties may be required to be copied as prepareFromQuery only copies properties that affect the SQL.- Overrides:
copyFromQueryin classObjectLevelReadQuery
-
prepare
protected void prepare() throws QueryExceptionINTERNAL: Prepare the receiver for execution in a session.- Overrides:
preparein classObjectLevelReadQuery- Throws:
QueryException
-
prepareCustomQuery
protected void prepareCustomQuery(DatabaseQuery customQuery)
INTERNAL: Set the properties needed to be cascaded into the custom query including the translation row. This is used only for primary key queries, as the descriptor query manager stores a predefined query for this query to avoid having to re-prepare and allow for customization.- Overrides:
prepareCustomQueryin classObjectBuildingQuery
-
prepareForExecution
public void prepareForExecution() throws QueryExceptionINTERNAL: Prepare the receiver for execution in a session.- Overrides:
prepareForExecutionin classReadQuery- Throws:
QueryException
-
prePrepare
protected void prePrepare() throws QueryExceptionINTERNAL: Prepare the receiver for execution in a session.- Overrides:
prePreparein classObjectLevelReadQuery- Throws:
QueryException
-
registerResultInUnitOfWork
public 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. If the query went to the database.Involves registering the query result individually and in totality, and hence refreshing / conforming is done here.
- Specified by:
registerResultInUnitOfWorkin classObjectLevelReadQuery- Parameters:
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.- Returns:
- the final (conformed, refreshed, wrapped) UnitOfWork query result
-
remoteExecute
protected java.lang.Object remoteExecute()
- Overrides:
remoteExecutein classDatabaseQuery
-
replaceValueHoldersIn
public java.util.Map replaceValueHoldersIn(java.lang.Object object, org.eclipse.persistence.internal.sessions.remote.RemoteSessionController controller)INTERNAL: replace the value holders in the specified result object(s)- Overrides:
replaceValueHoldersInin classDatabaseQuery
-
getQueryPrimaryKey
protected java.lang.Object getQueryPrimaryKey()
INTERNAL: Return the primary key stored in this query- Overrides:
getQueryPrimaryKeyin classObjectBuildingQuery- Returns:
- the selection id of this ReadObjectQuery
- See Also:
ReadObjectQuery
-
getSelectionId
public java.lang.Object getSelectionId()
PUBLIC: Return Id of the object to be selected by the query.
-
clearSelectionId
public void clearSelectionId()
INTERNAL: Clear the selection id and object. This is done after cloning queries to prepare them in inheritance.
-
setSelectionId
public void setSelectionId(java.lang.Object id)
PUBLIC: The Id of the object to be selected by the query. This will generate a query by primary key. This can be used instead of an Expression, SQL, or JPQL, or example object. The Id is the Id value for a singleton primary key, for a composite it is an instance of CacheId.- See Also:
CacheId
-
setSelectionKey
@Deprecated public void setSelectionKey(java.util.List selectionKey)
Deprecated.since EclipseLink 2.1, replaced by setSelectionId(Object)PUBLIC: The primary key can be specified if used instead of an expression or selection object. If composite the primary must be in the same order as defined in the descriptor.- See Also:
setSelectionId(Object)
-
setSelectionObject
public void setSelectionObject(java.lang.Object selectionObject)
PUBLIC: Used to set the where clause of the query. This can be used instead of a where clause expression for single object primary key queries. The selection object given should have a primary key defined, this primary key will be used to query the database instance of the same object. This is a basic form of query by example where only the primary key is required, it can be used for simple query forms, or testing.
-
setShouldLoadResultIntoSelectionObject
public void setShouldLoadResultIntoSelectionObject(boolean shouldLoadResultIntoSelectionObject)
PUBLIC: Allow for the selection object of the query to be refreshed or put into the EclipseLink cache. By default on a read or refresh the object in the cache is refreshed and returned or a new object is built from the database, in some cases such as EJB BMP it is desirable to refresh or load into the object passed into the read object query.Note: This forces the selection object into the cache a replaces any existing object that may already be there, this is a strict violation of object identity and other objects can still be referring to the old object.
-
setSingletonSelectionKey
@Deprecated public void setSingletonSelectionKey(java.lang.Object selectionKey)
Deprecated.since EclipseLink 2.1, replaced by setSelectionId(Object)PUBLIC: The primary key can be specified if used instead of an expression or selection object.- See Also:
setSelectionId(Object)
-
shouldCheckCacheByExactPrimaryKey
public boolean shouldCheckCacheByExactPrimaryKey()
PUBLIC: Return if cache should be checked.
-
shouldCheckCacheByPrimaryKey
public boolean shouldCheckCacheByPrimaryKey()
PUBLIC: Return if cache should be checked.
-
shouldCheckCacheThenDatabase
public boolean shouldCheckCacheThenDatabase()
PUBLIC: Return if cache should be checked.
-
shouldLoadResultIntoSelectionObject
public boolean shouldLoadResultIntoSelectionObject()
PUBLIC: return true if the result should be loaded into the passed in selection Object
-
hasNonDefaultFetchGroup
protected boolean hasNonDefaultFetchGroup()
INTERNAL: Return if the query has an non-default fetch group defined for itself.
-
-