QueryImpl (EclipseLink JPA 3.0.1 API)

java.lang.Object
- org.eclipse.persistence.internal.jpa.QueryImpl

Direct Known Subclasses:

EJBQueryImpl, StoredProcedureQueryImpl
```
public class QueryImpl
extends Object
```
Concrete JPA query class. The JPA query wraps a DatabaseQuery which is executed.

Field Summary

Fields
Modifier and Type	Field and Description
`protected DatabaseQuery`	`databaseQuery` Wrapped native query.
`protected EntityManagerImpl`	`entityManager`
`protected int`	`firstResultIndex`
`protected boolean`	`isShared` Stores if the wrapped query is shared, and requires cloning before being changed.
`protected jakarta.persistence.LockModeType`	`lockMode`
`protected int`	`maxResults`
`protected Map<String,jakarta.persistence.Parameter<?>>`	`parameters`
`protected Map<String,Object>`	`parameterValues`
`protected String`	`queryName`
`static int`	`UNDEFINED`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`QueryImpl(DatabaseQuery query, EntityManagerImpl entityManager)` Create an EJBQueryImpl with a DatabaseQuery.
`protected`	`QueryImpl(EntityManagerImpl entityManager)` Base constructor for EJBQueryImpl.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`applyArguments(StoredProcedureCall call, DatabaseQuery query)` Define the query arguments based on the procedure call.
`protected static DatabaseQuery`	`applyHints(Map<String,Object> hints, DatabaseQuery query, ClassLoader classLoader, AbstractSession session)` Set implementation-specific hints.
`protected void`	`cloneSharedQuery()` If the query was from the jpql parse cache it must be cloned before being modified.
`void`	`close()` This method should be called to close any left over open connection to the database (if there is one).
`protected Object`	`convertTemporalType(Object value, jakarta.persistence.TemporalType type)` Convert the given object to the class represented by the given temporal type.
`protected Object`	`executeReadQuery()` Execute a ReadQuery by assigning the stored parameter values and running it in the database
`int`	`executeUpdate()` Execute an update or delete statement.
`protected Session`	`getActiveSession()`
`DatabaseQuery`	`getDatabaseQuery()` Return the wrapped `DatabaseQuery` ensuring that if it `isShared` it is cloned before returning to prevent corruption of the query cache.
`DatabaseQuery`	`getDatabaseQueryInternal()` INTERNAL: Return the cached database query for this EJBQueryImpl.
`protected RuntimeException`	`getDetailedException(DatabaseException e)` Given a DatabaseException, this method will determine if we should throw a different more specific exception like a lock timeout exception.
`JpaEntityManager`	`getEntityManager()` Return the entityManager this query is tied to.
`int`	`getFirstResult()`
`jakarta.persistence.FlushModeType`	`getFlushMode()`
`Map<String,Object>`	`getHints()`
`protected Map<String,jakarta.persistence.Parameter<?>>`	`getInternalParameters()` Return the internal map of parameters.
`jakarta.persistence.LockModeType`	`getLockMode()` Get the current lock mode for the query.
`int`	`getMaxResults()`
`int`	`getMaxResultsInternal()`
`jakarta.persistence.Parameter<?>`	`getParameter(int position)`
`<T> jakarta.persistence.Parameter<T>`	`getParameter(int position, Class<T> type)`
`jakarta.persistence.Parameter<?>`	`getParameter(String name)`
`<T> jakarta.persistence.Parameter<T>`	`getParameter(String name, Class<T> type)`
`static String`	`getParameterId(jakarta.persistence.Parameter param)` Return the identifier of this parameter.
`Set<jakarta.persistence.Parameter<?>>`	`getParameters()`
`Object`	`getParameterValue(int position)` Return the value bound to the positional parameter.
`<T> T`	`getParameterValue(jakarta.persistence.Parameter<T> param)`
`Object`	`getParameterValue(String name)` Return the value bound to the named parameter.
`List`	`getResultList()` Execute the query and return the query results as a List.
`Object`	`getSingleResult()` Execute a SELECT query that returns a single untyped result.
`Set<String>`	`getSupportedHints()`
`boolean`	`isBound(jakarta.persistence.Parameter<?> param)` Return a boolean indicating whether a value has been bound to the parameter.
`protected boolean`	`isFlushModeAUTO()` Spec.
`protected boolean`	`isValidActualParameter(Object value, Class parameterType)`
`protected void`	`performPreQueryFlush()`
`protected List<Object>`	`processParameters()` Internal method to add the parameters values to the query prior to execution.
`protected void`	`propagateResultProperties()` Configure the firstResult, maxRows and lock mode in the EclipseLink ReadQuery.
`protected void`	`setAsDataModifyQuery()` INTERNAL: Change the internal query to data modify query.
`protected void`	`setAsSQLModifyQuery()` Internal method to change the wrapped query to a DataModifyQuery if necessary.
`protected void`	`setAsSQLReadQuery()` Internal method to change the wrapped query to a DataReadQuery if necessary.
`void`	`setDatabaseQuery(DatabaseQuery query)` Replace the cached query with the given query.
`QueryImpl`	`setFirstResult(int startPosition)` Set the position of the first result to retrieve.
`protected void`	`setFirstResultInternal(int startPosition)` Set the position of the first result to retrieve.
`QueryImpl`	`setFlushMode(jakarta.persistence.FlushModeType flushMode)` Set the flush mode type to be used for the query execution.
`protected void`	`setHintInternal(String hintName, Object value)` Set an implementation-specific hint.
`QueryImpl`	`setLockMode(jakarta.persistence.LockModeType lockMode)` Set the lock mode type to be used for the query execution.
`QueryImpl`	`setMaxResults(int maxResult)` Set the maximum number of results to retrieve.
`void`	`setMaxResultsInternal(int maxResult)` Set the maximum number of results to retrieve.
`protected void`	`setParameterInternal(int position, Object value)` Bind an argument to a positional parameter.
`protected void`	`setParameterInternal(String name, Object value, boolean isIndex)` Bind an argument to a named or indexed parameter.
`protected void`	`setRollbackOnly()`
`protected void`	`throwNonUniqueResultException(String message)`
`protected void`	`throwNoResultException(String message)`
`String`	`toString()`
`<T> T`	`unwrap(Class<T> cls)` Unwrap the query into the JPA implementation classes/interfaces or the underlying native EclipseLink query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNDEFINED
```
public static final int UNDEFINED
```
    See Also:
    
    Constant Field Values
  - databaseQuery
```
protected DatabaseQuery databaseQuery
```
    Wrapped native query. The query may be isShared
  - entityManager
```
protected EntityManagerImpl entityManager
```
  - queryName
```
protected String queryName
```
  - parameterValues
```
protected Map<String,Object> parameterValues
```
  - parameters
```
protected Map<String,jakarta.persistence.Parameter<?>> parameters
```
  - firstResultIndex
```
protected int firstResultIndex
```
  - maxResults
```
protected int maxResults
```
  - lockMode
```
protected jakarta.persistence.LockModeType lockMode
```
  - isShared
```
protected boolean isShared
```
    Stores if the wrapped query is shared, and requires cloning before being changed.
- Constructor Detail
  - QueryImpl
```
protected QueryImpl(EntityManagerImpl entityManager)
```
    Base constructor for EJBQueryImpl. Initializes basic variables.
  - QueryImpl
```
public QueryImpl(DatabaseQuery query,
                 EntityManagerImpl entityManager)
```
    Create an EJBQueryImpl with a DatabaseQuery.
- Method Detail
  - close
```
public void close()
```
    This method should be called to close any left over open connection to the database (if there is one).
  - setAsDataModifyQuery
```
protected void setAsDataModifyQuery()
```
    INTERNAL: Change the internal query to data modify query.
  - setAsSQLModifyQuery
```
protected void setAsSQLModifyQuery()
```
    Internal method to change the wrapped query to a DataModifyQuery if necessary. When created, the query is created as a DataReadQuery as it is unknown if it is a SELECT or UPDATE. Note that this prevents the original named query from every being prepared.
  - setAsSQLReadQuery
```
protected void setAsSQLReadQuery()
```
    Internal method to change the wrapped query to a DataReadQuery if necessary. This should never occur, but could possibly if the same query was executed as executeUpdate() then as getResultList(). Note that the initial conversion to modify would loose any read settings that had been set.
  - executeReadQuery
```
protected Object executeReadQuery()
```
    Execute a ReadQuery by assigning the stored parameter values and running it in the database
    
    Returns:
    
    the results of the query execution
  - executeUpdate
```
public int executeUpdate()
```
    Execute an update or delete statement.
    
    Returns:
    
    the number of entities updated or deleted
  - getDatabaseQuery
```
public DatabaseQuery getDatabaseQuery()
```
    Return the wrapped DatabaseQuery ensuring that if it isShared it is cloned before returning to prevent corruption of the query cache.
    
    See Also:
    
    getDatabaseQueryInternal()
  - getDatabaseQueryInternal
```
public DatabaseQuery getDatabaseQueryInternal()
```
    INTERNAL: Return the cached database query for this EJBQueryImpl. If the query is a named query and it has not yet been looked up, the query will be looked up and stored as the cached query.
  - getDetailedException
```
protected RuntimeException getDetailedException(DatabaseException e)
```
    Given a DatabaseException, this method will determine if we should throw a different more specific exception like a lock timeout exception.
  - getEntityManager
```
public JpaEntityManager getEntityManager()
```
    Return the entityManager this query is tied to.
  - getInternalParameters
```
protected Map<String,jakarta.persistence.Parameter<?>> getInternalParameters()
```
    Return the internal map of parameters.
  - getLockMode
```
public jakarta.persistence.LockModeType getLockMode()
```
    Get the current lock mode for the query.
    
    Returns:
    
    lock mode
    
    Throws:
    
    IllegalStateException - if not a Java Persistence query language SELECT query
  - getResultList
```
public List getResultList()
```
    Execute the query and return the query results as a List.
    
    Returns:
    
    a list of the results
  - getSingleResult
```
public Object getSingleResult()
```
    Execute a SELECT query that returns a single untyped result.
    
    Returns:
    
    the result
    
    Throws:
    
    jakarta.persistence.NoResultException - if there is no result
    
    jakarta.persistence.NonUniqueResultException - if more than one result
    
    IllegalStateException - if called for a Java Persistence query language UPDATE or DELETE statement
    
    jakarta.persistence.QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back
    
    jakarta.persistence.TransactionRequiredException - if a lock mode other than NONE has been been set and there is no transaction or the persistence context has not been joined to the transaction
    
    jakarta.persistence.PessimisticLockException - if pessimistic locking fails and the transaction is rolled back
    
    jakarta.persistence.LockTimeoutException - if pessimistic locking fails and only the statement is rolled back
    
    jakarta.persistence.PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back
  - processParameters
```
protected List<Object> processParameters()
```
    Internal method to add the parameters values to the query prior to execution. Returns a list of parameter values in the order the parameters are defined for the databaseQuery.
  - setDatabaseQuery
```
public void setDatabaseQuery(DatabaseQuery query)
```
    Replace the cached query with the given query.
  - setFirstResult
```
public QueryImpl setFirstResult(int startPosition)
```
    Set the position of the first result to retrieve.
    
    Parameters:
    
    startPosition - position of the first result, numbered from 0
    
    Returns:
    
    the same query instance
  - getFirstResult
```
public int getFirstResult()
```
    Since:
    
    Java Persistence API 2.0
    
    See Also:
    
    Query.getFirstResult()
  - setFlushMode
```
public QueryImpl setFlushMode(jakarta.persistence.FlushModeType flushMode)
```
    Set the flush mode type to be used for the query execution.
    
    Parameters:
    
    flushMode -
  - setFirstResultInternal
```
protected void setFirstResultInternal(int startPosition)
```
    Set the position of the first result to retrieve.
    
    Parameters:
    
    startPosition - position of the first result, numbered from 0.
  - applyArguments
```
protected static void applyArguments(StoredProcedureCall call,
                                     DatabaseQuery query)
```
    Define the query arguments based on the procedure call.
  - applyHints
```
protected static DatabaseQuery applyHints(Map<String,Object> hints,
                                          DatabaseQuery query,
                                          ClassLoader classLoader,
                                          AbstractSession session)
```
    Set implementation-specific hints.
    
    Parameters:
    
    hints - a list of hints to be applied to the query
    
    query - the query to apply the hints to
  - getParameterId
```
public static String getParameterId(jakarta.persistence.Parameter param)
```
    Return the identifier of this parameter. This will be the name if it is set, else it will be the position
    
    Parameters:
    
    param -
    
    Returns:
  - isBound
```
public boolean isBound(jakarta.persistence.Parameter<?> param)
```
    Return a boolean indicating whether a value has been bound to the parameter.
    
    Parameters:
    
    param - parameter object
    
    Returns:
    
    boolean indicating whether parameter has been bound
  - isFlushModeAUTO
```
protected boolean isFlushModeAUTO()
```
    Spec. 3.5.2: "FlushMode.AUTO is set on the Query object, or if the flush mode setting for the persistence context is AUTO (the default) and a flush mode setting has not been specified for the Query object, the persistence provider is responsible for ensuring that all updates to the state of all entities in the persistence context which could potentially affect the result of the query are visible to the processing of the query."
  - setHintInternal
```
protected void setHintInternal(String hintName,
                               Object value)
```
    Set an implementation-specific hint. If the hint name is not recognized, it is silently ignored.
    
    Throws:
    
    IllegalArgumentException - if the second argument is not valid for the implementation.
  - setLockMode
```
public QueryImpl setLockMode(jakarta.persistence.LockModeType lockMode)
```
    Set the lock mode type to be used for the query execution.
    
    Parameters:
    
    lockMode -
    
    Throws:
    
    IllegalStateException - if not a Java Persistence query language SELECT query
  - cloneSharedQuery
```
protected void cloneSharedQuery()
```
    If the query was from the jpql parse cache it must be cloned before being modified.
  - convertTemporalType
```
protected Object convertTemporalType(Object value,
                                     jakarta.persistence.TemporalType type)
```
    Convert the given object to the class represented by the given temporal type.
    
    Returns:
    
    an object representing the given TemporalType.
  - setMaxResults
```
public QueryImpl setMaxResults(int maxResult)
```
    Set the maximum number of results to retrieve.
    
    Parameters:
    
    maxResult -
    
    Returns:
    
    the same query instance
  - getMaxResults
```
public int getMaxResults()
```
    Since:
    
    Java Persistence API 2.0
    
    See Also:
    
    Query.getMaxResults()
  - getMaxResultsInternal
```
public int getMaxResultsInternal()
```
    Since:
    
    Java Persistence API 2.0
    
    See Also:
    
    Query.getMaxResults()
  - setMaxResultsInternal
```
public void setMaxResultsInternal(int maxResult)
```
    Set the maximum number of results to retrieve.
    
    Parameters:
    
    maxResult -
  - propagateResultProperties
```
protected void propagateResultProperties()
```
    Configure the firstResult, maxRows and lock mode in the EclipseLink ReadQuery.
  - setParameterInternal
```
protected void setParameterInternal(int position,
                                    Object value)
```
    Bind an argument to a positional parameter.
    
    Parameters:
    
    position -
    
    value -
  - setParameterInternal
```
protected void setParameterInternal(String name,
                                    Object value,
                                    boolean isIndex)
```
    Bind an argument to a named or indexed parameter.
    
    Parameters:
    
    name - the parameter name
    
    value - to bind
    
    isIndex - defines if index or named
  - isValidActualParameter
```
protected boolean isValidActualParameter(Object value,
                                         Class parameterType)
```
  - getActiveSession
```
protected Session getActiveSession()
```
  - performPreQueryFlush
```
protected void performPreQueryFlush()
```
  - setRollbackOnly
```
protected void setRollbackOnly()
```
  - throwNoResultException
```
protected void throwNoResultException(String message)
```
  - throwNonUniqueResultException
```
protected void throwNonUniqueResultException(String message)
```
  - getFlushMode
```
public jakarta.persistence.FlushModeType getFlushMode()
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getFlushMode()
  - getHints
```
public Map<String,Object> getHints()
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getHints()
  - getParameter
```
public <T> jakarta.persistence.Parameter<T> getParameter(String name,
                                                         Class<T> type)
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getParameter(String, Class)
  - getParameter
```
public <T> jakarta.persistence.Parameter<T> getParameter(int position,
                                                         Class<T> type)
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getParameter(int, Class)
  - getParameter
```
public jakarta.persistence.Parameter<?> getParameter(String name)
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getParameter(String, Class)
  - getParameter
```
public jakarta.persistence.Parameter<?> getParameter(int position)
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getParameter(int, Class)
  - getParameterValue
```
public <T> T getParameterValue(jakarta.persistence.Parameter<T> param)
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getParameterValue(Parameter)
  - getParameterValue
```
public Object getParameterValue(String name)
```
    Return the value bound to the named parameter.
    
    Parameters:
    
    name -
    
    Returns:
    
    parameter value
    
    Throws:
    
    IllegalStateException - if the parameter has not been been bound
  - getParameterValue
```
public Object getParameterValue(int position)
```
    Return the value bound to the positional parameter.
    
    Parameters:
    
    position -
    
    Returns:
    
    parameter value
    
    Throws:
    
    IllegalStateException - if the parameter has not been been bound
  - getParameters
```
public Set<jakarta.persistence.Parameter<?>> getParameters()
```
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.getParameters()
  - getSupportedHints
```
public Set<String> getSupportedHints()
```
    Since:
    
    Java Persistence 2.0
  - unwrap
```
public <T> T unwrap(Class<T> cls)
```
    Unwrap the query into the JPA implementation classes/interfaces or the underlying native EclipseLink query.
    
    Since:
    
    Java Persistence 2.0
    
    See Also:
    
    Query.unwrap(Class)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class QueryImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNDEFINED

databaseQuery

entityManager

queryName

parameterValues

parameters

firstResultIndex

maxResults

lockMode

isShared

Constructor Detail

QueryImpl

QueryImpl

Method Detail

close

setAsDataModifyQuery

setAsSQLModifyQuery

setAsSQLReadQuery

executeReadQuery

executeUpdate

getDatabaseQuery

getDatabaseQueryInternal

getDetailedException

getEntityManager

getInternalParameters

getLockMode

getResultList

getSingleResult

processParameters

setDatabaseQuery

setFirstResult

getFirstResult

setFlushMode

setFirstResultInternal

applyArguments

applyHints

getParameterId

isBound

isFlushModeAUTO

setHintInternal

setLockMode

cloneSharedQuery

convertTemporalType

setMaxResults

getMaxResults

getMaxResultsInternal

setMaxResultsInternal

propagateResultProperties

setParameterInternal

setParameterInternal

isValidActualParameter

getActiveSession

performPreQueryFlush

setRollbackOnly

throwNoResultException

throwNonUniqueResultException

getFlushMode

getHints

getParameter

getParameter

getParameter

getParameter

getParameterValue

getParameterValue

getParameterValue

getParameters

getSupportedHints

unwrap

toString