org.eclipse.persistence.queries
Class EJBQLPlaceHolderQuery
java.lang.Object
org.eclipse.persistence.queries.DatabaseQuery
org.eclipse.persistence.queries.EJBQLPlaceHolderQuery
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
public class EJBQLPlaceHolderQuery
- extends DatabaseQuery
Purpose:
A EJB3 placeholder Query object to store EJBQL strings so that processing the string is delayed
until Login
- See Also:
- Serialized Form
- Author:
- Chris Delahunt
- Since:
- TopLink Java Essentials
Fields inherited from class org.eclipse.persistence.queries.DatabaseQuery |
accessor, arguments, argumentTypeNames, argumentTypes, argumentValues, CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, cascadePolicy, CascadePrivateParts, descriptor, executionSession, hintString, isCustomQueryUsed, isExecutionClone, isFromParseCache, isPrepared, isUserDefined, name, NoCascading, properties, queryMechanism, queryTimeout, redirector, session, sessionName, shouldBindAllParameters, shouldCacheStatement, shouldCloneCall, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, translationRow |
Method Summary |
java.lang.Object |
executeDatabaseQuery()
INTERNAL:
This should never be called and is only here because it is needed as an extension
to DatabaseQuery. |
java.lang.String |
getEJBQLString()
INTERNAL:
Add the expression value to be included in the result. |
java.util.HashMap |
getHints()
INTERNAL:
Accessor methods for hints that would be added to the EJBQuery class and
applied to the TopLink query. |
DatabaseQuery |
processEjbQLQuery(Session session)
|
void |
setEJBQLString(java.lang.String ejbQLString)
PUBLIC:
Set the EJBQL string of the query. |
void |
setHints(java.util.HashMap hints)
|
Methods inherited from class org.eclipse.persistence.queries.DatabaseQuery |
addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildSelectionCriteria, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkDescriptor, checkEarlyReturn, checkForCustomQuery, checkPrepare, checkPrepare, clone, clonedQueryExecutionComplete, convertClassNamesToClasses, copyFromQuery, deploymentSetShouldMaintainCache, deploymentShouldMaintainCache, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, executeInUnitOfWork, extractRemoteResult, getAccessor, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getCall, getCalls, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDescriptor, getDomainClassNounName, getExecutionSession, getFlushOnExecute, getHintString, getJPQLString, getName, getProperties, getProperty, getQueryMechanism, getQueryNounName, getQueryTimeout, getRedirector, getReferenceClass, getReferenceClassName, getSelectionCriteria, getSensorName, getSession, getSessionName, getShouldBindAllParameters, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasArguments, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isCustomQueryUsed, isCustomSelectionQuery, isDataModifyQuery, isDataReadQuery, isDefaultPropertiesQuery, isDeleteAllQuery, isDeleteObjectQuery, isDirectReadQuery, isExecutionClone, isExpressionQuery, isFromParseCache, isInsertObjectQuery, isModifyAllQuery, isModifyQuery, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, isValueReadQuery, isWriteObjectQuery, maintainCache, prepare, prepareCall, prepareCustomQuery, prepareForExecution, prepareForRemoteExecution, prepareFromQuery, redirectQuery, remoteExecute, remoteExecute, removeProperty, replaceValueHoldersIn, rowFromArguments, setAccessor, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setCall, setCascadePolicy, setDatasourceCall, setDescriptor, setExecutionSession, setFlushOnExecute, setHintString, setIsCustomQueryUsed, setIsExecutionClone, setIsFromParseCache, setIsPrepared, setIsUserDefined, setJPQLString, setName, setProperties, setProperty, setQueryMechanism, setQueryTimeout, setRedirector, setSelectionCriteria, setSession, setSessionName, setShouldBindAllParameters, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldUseWrapperPolicy, setSQLStatement, setSQLString, setTranslationRow, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldCloneCall, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, toString |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
EJBQLPlaceHolderQuery
public EJBQLPlaceHolderQuery()
EJBQLPlaceHolderQuery
public EJBQLPlaceHolderQuery(java.lang.String ejbQLString)
EJBQLPlaceHolderQuery
public EJBQLPlaceHolderQuery(java.lang.String name,
java.lang.String ejbql,
java.util.HashMap hints)
EJBQLPlaceHolderQuery
public EJBQLPlaceHolderQuery(java.lang.String name,
java.lang.String ejbql,
java.lang.Boolean flushOnExecute,
java.util.HashMap hints)
getEJBQLString
public java.lang.String getEJBQLString()
- INTERNAL:
Add the expression value to be included in the result.
EXAMPLE: reportQuery.addItem("name", expBuilder.get("firstName").toUpperCase());
The resultType can be specified to support EJBQL that adheres to the
EJB 3.0 spec.
- Overrides:
getEJBQLString
in class DatabaseQuery
setEJBQLString
public void setEJBQLString(java.lang.String ejbQLString)
- Description copied from class:
DatabaseQuery
- PUBLIC:
Set the EJBQL string of the query.
If arguments are required in the string they will be preceeded by "?" then the argument number.
- Overrides:
setEJBQLString
in class DatabaseQuery
getHints
public java.util.HashMap getHints()
- INTERNAL:
Accessor methods for hints that would be added to the EJBQuery class and
applied to the TopLink query.
setHints
public void setHints(java.util.HashMap hints)
processEjbQLQuery
public DatabaseQuery processEjbQLQuery(Session session)
executeDatabaseQuery
public java.lang.Object executeDatabaseQuery()
throws DatabaseException,
OptimisticLockException
- INTERNAL:
This should never be called and is only here because it is needed as an extension
to DatabaseQuery. An exception should be thrown to warn users, but for now
it will process the EJBQL and execute the resulting query instead.
- 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.