oracle.toplink.essentials.internal.ejb.cmp3

Class EJBQueryImpl

java.lang.Object

oracle.toplink.essentials.internal.ejb.cmp3.base.EJBQueryImpl

oracle.toplink.essentials.internal.ejb.cmp3.EJBQueryImpl

All Implemented Interfaces:

javax.persistence.Query, EJBQuery

public class EJBQueryImpl
extends EJBQueryImpl
implements EJBQuery

Concrete EJB 3.0 query class To do: Internationalize exceptions Change TopLink exceptions to exception types used by the spec Named Parameters Report Query firstResultIndex set in query framework temporal type parameters Change single result to use ReadObjectQuery

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.ejb.cmp3.base.EJBQueryImpl

databaseQuery, entityManager, firstResultIndex, maxResults, maxRows, parameters, queryName

Constructor Summary

Constructors

Modifier	Constructor and Description
	EJBQueryImpl(DatabaseQuery query, EntityManagerImpl entityManager) Create an EJBQueryImpl with a TopLink query.
protected	EJBQueryImpl(EntityManagerImpl entityManager) Base constructor for EJBQueryImpl.
	EJBQueryImpl(java.lang.String ejbql, EntityManagerImpl entityManager) Build an EJBQueryImpl based on the given ejbql string
	EJBQueryImpl(java.lang.String queryDescription, EntityManagerImpl entityManager, boolean isNamedQuery) Create an EJBQueryImpl with either a query name or an ejbql string

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	convertTemporalType(java.lang.Object value, javax.persistence.TemporalType type) Convert the given object to the class represented by the given temporal type.
EntityManager	getEntityManager() Return the entityManager this query is tied to.
javax.persistence.Query	setFirstResult(int startPosition) Set the position of the first result to retrieve.
javax.persistence.Query	setFlushMode(javax.persistence.FlushModeType flushMode) Set the flush mode type to be used for the query execution.
javax.persistence.Query	setHint(java.lang.String hintName, java.lang.Object value) Set an implementation-specific hint.
javax.persistence.Query	setMaxResults(int maxResult) Set the maximum number of results to retrieve.
javax.persistence.Query	setParameter(int position, java.util.Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
javax.persistence.Query	setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
javax.persistence.Query	setParameter(int position, java.lang.Object value) Bind an argument to a positional parameter.
javax.persistence.Query	setParameter(java.lang.String name, java.util.Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
javax.persistence.Query	setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
javax.persistence.Query	setParameter(java.lang.String name, java.lang.Object value) Bind an argument to a named parameter.
protected void	throwNonUniqueResultException(java.lang.String message)
protected void	throwNoResultException(java.lang.String message)

Methods inherited from class oracle.toplink.essentials.internal.ejb.cmp3.base.EJBQueryImpl

applyHints, buildEJBQLDatabaseQuery, buildEJBQLDatabaseQuery, buildEJBQLDatabaseQuery, buildEJBQLDatabaseQuery, buildEJBQLDatabaseQuery, buildEJBQLDatabaseQuery, buildSQLDatabaseQuery, buildSQLDatabaseQuery, buildSQLDatabaseQuery, buildSQLDatabaseQuery, buildSQLDatabaseQuery, buildSQLDatabaseQuery, executeReadQuery, executeUpdate, getActiveSession, getDatabaseQuery, getResultCollection, getResultList, getSingleResult, isFlushModeAUTO, isValidActualParameter, performPreQueryFlush, processParameters, propagateResultProperties, setAsSQLModifyQuery, setAsSQLReadQuery, setDatabaseQuery, setFirstResultInternal, setHintInternal, setMaxResultsInternal, setParameterInternal, setParameterInternal, setRollbackOnly

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.toplink.essentials.ejb.cmp3.EJBQuery

getDatabaseQuery, getResultCollection, setDatabaseQuery

Methods inherited from interface javax.persistence.Query

executeUpdate, getResultList, getSingleResult

Constructor Detail

EJBQueryImpl

protected EJBQueryImpl(EntityManagerImpl entityManager)

Base constructor for EJBQueryImpl. Initializes basic variables. An EJBQLQueryImpl may only ever be tied to one entityManager.

EJBQueryImpl

public EJBQueryImpl(DatabaseQuery query,
                    EntityManagerImpl entityManager)

Create an EJBQueryImpl with a TopLink query.

Parameters:

query -

entityManager -

EJBQueryImpl

public EJBQueryImpl(java.lang.String ejbql,
                    EntityManagerImpl entityManager)

Build an EJBQueryImpl based on the given ejbql string

Parameters:

ejbql -

entityManager -

EJBQueryImpl

public EJBQueryImpl(java.lang.String queryDescription,
                    EntityManagerImpl entityManager,
                    boolean isNamedQuery)

Create an EJBQueryImpl with either a query name or an ejbql string

Parameters:

queryDescription -

entityManager -

isNamedQuery - determines whether to treat the query description as ejbql or a query name

Method Detail

convertTemporalType

protected java.lang.Object convertTemporalType(java.lang.Object value,
                                               javax.persistence.TemporalType type)

Convert the given object to the class represented by the given temporal type.

Returns:

an object represting the given TemporalType

getEntityManager

public EntityManager getEntityManager()

Return the entityManager this query is tied to.

Specified by:

getEntityManager in interface EJBQuery

setFirstResult

public javax.persistence.Query setFirstResult(int startPosition)

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface javax.persistence.Query

Parameters:

start - position of the first result, numbered from 0

Returns:

the same query instance

setFlushMode

public javax.persistence.Query setFlushMode(javax.persistence.FlushModeType flushMode)

Set the flush mode type to be used for the query execution.

Specified by:

setFlushMode in interface javax.persistence.Query

Parameters:

flushMode -

setHint

public javax.persistence.Query setHint(java.lang.String hintName,
                                       java.lang.Object value)

Set an implementation-specific hint. If the hint name is not recognized, it is silently ignored.

Specified by:

setHint in interface javax.persistence.Query

Parameters:

hintName -

value -

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if the second argument is not valid for the implementation

setMaxResults

public javax.persistence.Query setMaxResults(int maxResult)

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface javax.persistence.Query

Parameters:

maxResult -

Returns:

the same query instance

setParameter

public javax.persistence.Query setParameter(java.lang.String name,
                                            java.lang.Object value)

Bind an argument to a named parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - the parameter name

value -

Returns:

the same query instance

setParameter

public javax.persistence.Query setParameter(java.lang.String name,
                                            java.util.Date value,
                                            javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Date to a named parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name -

value -

temporalType -

Returns:

the same query instance

setParameter

public javax.persistence.Query setParameter(java.lang.String name,
                                            java.util.Calendar value,
                                            javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Calendar to a named parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name -

value -

temporalType -

Returns:

the same query instance

setParameter

public javax.persistence.Query setParameter(int position,
                                            java.lang.Object value)

Bind an argument to a positional parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position -

value -

Returns:

the same query instance

setParameter

public javax.persistence.Query setParameter(int position,
                                            java.util.Date value,
                                            javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Date to a positional parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position -

value - Query API Enterprise JavaBeans 3.0, Early Draft Entity Beans Sun Microsystems Inc

temporalType -

Returns:

the same query instance

setParameter

public javax.persistence.Query setParameter(int position,
                                            java.util.Calendar value,
                                            javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Calendar to a positional parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position -

value -

temporalType -

Returns:

the same query instance

throwNoResultException

protected void throwNoResultException(java.lang.String message)

Specified by:

throwNoResultException in class EJBQueryImpl

throwNonUniqueResultException

protected void throwNonUniqueResultException(java.lang.String message)

Specified by:

throwNonUniqueResultException in class EJBQueryImpl