Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa

Class JPAQuery

java.lang.Object

org.eclipse.persistence.queries.DatabaseQuery

org.eclipse.persistence.internal.jpa.JPAQuery

All Implemented Interfaces:

Serializable, Cloneable

public class JPAQuery
extends DatabaseQuery

Purpose: A JPA placeholder Query object to store JPQL strings so that processing the string is delayed until Login.

Since:

TopLink Essentials

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.queries.DatabaseQuery

DatabaseQuery.ParameterType

Field Summary

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
JPAQuery()
JPAQuery(String jpqlString)
JPAQuery(String name, String jpqlString, String lockMode, Map<String,Object> hints)	JPQL
JPAQuery(String queryName, String sqlString, Map<String,Object> hints)
JPAQuery(String queryName, StoredProcedureCall call, Map<String,Object> hints)

Method Summary

Modifier and Type	Method	Description
void	addResultClassNames(String className)
void	addResultSetMapping(String resultSetMapping)
Object	executeDatabaseQuery()	INTERNAL: This should never be called and is only here because it is needed as an extension to DatabaseQuery.
DatabaseQuery	getDatabaseQuery()
List<ClassDescriptor>	getDescriptors()	INTERNAL: For table per tenant queries the descriptor list will extracted from parsing the jpql query and cached here.
Map<String,Object>	getHints()	Return the JPA query hints.
String	getJPQLString()	Return the JPQL string.
boolean	isJPQLQuery()	Return true if this query is a jpql query.
boolean	isSQLQuery()	Return true if this query is an sql query.
void	prepare()	INTERNAL: Generate the DatabaseQuery query from the JPA named query.
DatabaseQuery	processJPQLQuery(Session session)	INTERNAL: Convert the JPA query into a DatabaseQuery.
DatabaseQuery	processSQLQuery(Session session)	INTERNAL: Convert the SQL string into a DatabaseQuery.
DatabaseQuery	processStoredProcedureQuery(Session session)	INTERNAL: Convert the StoredProc call into a DatabaseQuery.
void	setDatabaseQuery(DatabaseQuery databaseQuery)
void	setDescriptors(List<ClassDescriptor> descriptors)	INTERNAL: For table per tenant queries the descriptor list will extracted from parsing the jpql query and cached here.
void	setHints(Map<String,Object> hints)
void	setJPQLString(String jpqlString)	PUBLIC: Set the JPQL string of the query.
void	setResultClassName(String className)
void	setResultSetMappings(List<String> resultSetMappings)

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, checkDescriptor, checkEarlyReturn, checkForCustomQuery, checkPrepare, checkPrepare, clone, clonedQueryExecutionComplete, convertClassNamesToClasses, copyFromQuery, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, executeInUnitOfWork, extractRemoteResult, getAccessor, getAccessors, getArgumentParameterTypes, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getBatchObjects, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDefaultRedirector, getDescriptor, getDomainClassNounName, getDoNotRedirect, getEJBQLString, getExecutionSession, getFlushOnExecute, getHintString, getMonitorName, getName, getNullableArguments, getParameterDelimiter, getParameterDelimiterChar, getPartitioningPolicy, getProperties, getProperty, getQueryMechanism, getQueryNounName, getQueryTimeout, getQueryTimeoutUnit, getRedirector, getRedirectorForQuery, getReferenceClass, getReferenceClassName, 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, isDefaultPropertiesQuery, isDeleteAllQuery, isDeleteObjectQuery, isDirectReadQuery, isExecutionClone, isExpressionQuery, isInsertObjectQuery, isJPQLCallQuery, isModifyAllQuery, isModifyQuery, isNativeConnectionRequired, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isResultSetMappingQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, isUserDefinedSQLCall, isValueReadQuery, isWriteObjectQuery, maintainCache, prepareCall, prepareCustomQuery, prepareForExecution, prepareForRemoteExecution, prepareFromQuery, prepareInternal, redirectQuery, remoteExecute, remoteExecute, removeProperty, replaceValueHoldersIn, resetMonitorName, retrieveBypassCache, rowFromArguments, setAccessor, setAccessors, setAllowNativeSQLQuery, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setBatchObjects, setCall, setCascadePolicy, setDatasourceCall, setDescriptor, setDoNotRedirect, setEJBQLString, setExecutionSession, setFlushOnExecute, setHintString, setIsCustomQueryUsed, setIsExecutionClone, setIsNativeConnectionRequired, setIsPrepared, setIsUserDefined, setIsUserDefinedSQLCall, setName, setNullableArguments, setParameterDelimiter, setPartitioningPolicy, setProperties, setProperty, setQueryMechanism, setQueryTimeout, setQueryTimeoutUnit, setRedirector, setSelectionCriteria, 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, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JPAQuery

public JPAQuery()

JPAQuery

public JPAQuery(String jpqlString)

JPAQuery

public JPAQuery(String name,
 String jpqlString,
 String lockMode,
 Map<String,Object> hints)

JPQL

JPAQuery

public JPAQuery(String queryName,
 String sqlString,
 Map<String,Object> hints)

JPAQuery

public JPAQuery(String queryName,
 StoredProcedureCall call,
 Map<String,Object> hints)

Method Details

addResultClassNames

public void addResultClassNames(String className)

addResultSetMapping

public void addResultSetMapping(String resultSetMapping)

executeDatabaseQuery

public Object executeDatabaseQuery()
                            throws DatabaseException,
OptimisticLockException

INTERNAL: This should never be called and is only here because it is needed as an extension to DatabaseQuery. Perhaps exception should be thrown to warn users, but for now it will execute the resulting query instead, this allows JPA style queries to be executed on a normal EclipseLink Session.

Specified by:

executeDatabaseQuery in class DatabaseQuery

Returns:

- the result of executing the query.

Throws:

DatabaseException - - an error has occurred on the database.

OptimisticLockException - - an error has occurred using the optimistic lock feature.

getDatabaseQuery

public DatabaseQuery getDatabaseQuery()

getDescriptors

public List<ClassDescriptor> getDescriptors()

INTERNAL: For table per tenant queries the descriptor list will extracted from parsing the jpql query and cached here.

Overrides:

getDescriptors in class DatabaseQuery

getHints

public Map<String,Object> getHints()

Return the JPA query hints.

getJPQLString

public String getJPQLString()

Return the JPQL string.

Overrides:

getJPQLString in class DatabaseQuery

isJPQLQuery

public boolean isJPQLQuery()

Return true if this query is a jpql query.

isSQLQuery

public boolean isSQLQuery()

Return true if this query is an sql query.

prepare

public void prepare()

INTERNAL: Generate the DatabaseQuery query from the JPA named query.

Overrides:

prepare in class DatabaseQuery

processJPQLQuery

public DatabaseQuery processJPQLQuery(Session session)

INTERNAL: Convert the JPA query into a DatabaseQuery.

processSQLQuery

public DatabaseQuery processSQLQuery(Session session)

INTERNAL: Convert the SQL string into a DatabaseQuery.

processStoredProcedureQuery

public DatabaseQuery processStoredProcedureQuery(Session session)

INTERNAL: Convert the StoredProc call into a DatabaseQuery.

setDatabaseQuery

public void setDatabaseQuery(DatabaseQuery databaseQuery)

setDescriptors

public void setDescriptors(List<ClassDescriptor> descriptors)

INTERNAL: For table per tenant queries the descriptor list will extracted from parsing the jpql query and cached here.

setHints

public void setHints(Map<String,Object> hints)

setJPQLString

public void setJPQLString(String jpqlString)

Description copied from class: DatabaseQuery

PUBLIC: Set the JPQL string of the query. If arguments are required in the string they will be preceded by ":" then the argument name. The JPQL arguments must also be added as argument to the query.

Overrides:

setJPQLString in class DatabaseQuery

setResultClassName

public void setResultClassName(String className)

setResultSetMappings

public void setResultSetMappings(List<String> resultSetMappings)