JDOQLTypedQueryImpl (DataNucleus JDO API plugin 4.2.1 API)

java.lang.Object
- org.datanucleus.api.jdo.query.AbstractJDOQLTypedQuery<T>
- - org.datanucleus.api.jdo.query.JDOQLTypedQueryImpl<T>

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, javax.jdo.JDOQLTypedQuery<T>
```
public class JDOQLTypedQueryImpl<T>
extends AbstractJDOQLTypedQuery<T>
implements javax.jdo.JDOQLTypedQuery<T>
```
Implementation of a JDOQLTypedQuery. Note that a JDOQLTypedQuery only supports named parameters.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Collection<T>`	`candidates`
`protected Integer`	`datastoreReadTimeout`
`protected Integer`	`datastoreWriteTimeout`
`protected Map<String,Object>`	`extensions`
`protected JDOFetchPlan`	`fetchPlan`
`protected boolean`	`ignoreCache`
`protected Set<org.datanucleus.store.query.Query>`	`internalQueries` Internal queries generated by this typesafe query.
`protected Map<String,ExpressionImpl>`	`parameterExprByName` Map of parameter expression keyed by the name.
`protected Map<String,Object>`	`parameterValuesByName` Map of parameters keyed by their name/expression.
`protected Boolean`	`serializeRead`
`protected Set<JDOQLTypedSubqueryImpl>`	`subqueries` Set of any subqueries used by this query.

Fields inherited from class org.datanucleus.api.jdo.query.AbstractJDOQLTypedQuery
candidateAlias, candidateCls, compilation, ec, filter, grouping, having, ordering, pm, queryString, rangeLowerExpr, rangeUpperExpr, result, resultClass, resultDistinct, subclasses, type, unique, updateExprs, updateVals

Fields inherited from interface javax.jdo.JDOQLTypedQuery
QUERY_CLASS_PREFIX

Constructor Summary

Constructors
Constructor and Description

JDOQLTypedQueryImpl(javax.jdo.PersistenceManager pm, Class<T> candidateClass)
Constructor for a typesafe query.

Constructors
Constructor and Description
`JDOQLTypedQueryImpl(javax.jdo.PersistenceManager pm, Class<T> candidateClass)` Constructor for a typesafe query.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`assertIsModifiable()` Method to throw an exception if the query is currently not modifiable.
`void`	`cancel(Thread thread)`
`void`	`cancelAll()`
`javax.jdo.query.PersistableExpression`	`candidate()`
`javax.jdo.query.CharacterExpression`	`characterParameter(String name)`
`void`	`close()`
`void`	`close(Object result)`
`void`	`closeAll()`
`javax.jdo.query.CollectionExpression`	`collectionParameter(String name)`
`org.datanucleus.query.compiler.QueryCompilation`	`compile(org.datanucleus.metadata.MetaDataManager mmgr, org.datanucleus.ClassLoaderResolver clr)` Method to compile the typesafe query.
`javax.jdo.JDOQLTypedQuery<T>`	`datastoreReadTimeoutMillis(Integer interval)`
`javax.jdo.JDOQLTypedQuery<T>`	`datastoreWriteTimeoutMillis(Integer interval)`
`javax.jdo.query.DateExpression`	`dateParameter(String name)`
`javax.jdo.query.DateTimeExpression`	`datetimeParameter(String name)`
`long`	`delete()` Extension method to provide bulk delete capabilities (not part of JDO).
`long`	`deletePersistentAll()`
`javax.jdo.JDOQLTypedQuery<T>`	`excludeSubclasses()`
`protected Object`	`executeInternalQuery(org.datanucleus.store.query.Query internalQuery)`
`List<T>`	`executeList()`
`List`	`executeResultList()`
`<R> List<R>`	`executeResultList(Class<R> resultCls)`
`Object`	`executeResultUnique()`
`<R> R`	`executeResultUnique(Class<R> resultCls)`
`T`	`executeUnique()`
`javax.jdo.JDOQLTypedQuery<T>`	`extension(String key, Object value)`
`javax.jdo.JDOQLTypedQuery<T>`	`extensions(Map values)`
`javax.jdo.JDOQLTypedQuery<T>`	`filter(javax.jdo.query.BooleanExpression expr)`
`Integer`	`getDatastoreReadTimeoutMillis()`
`Integer`	`getDatastoreWriteTimeoutMillis()`
`javax.jdo.FetchPlan`	`getFetchPlan()`
`boolean`	`getIgnoreCache()`
`protected org.datanucleus.store.query.Query`	`getInternalQuery()` Convenience method to generate an internal DataNucleus Query and apply the generic compilation to it.
`String`	`getJDOQLForExpression(org.datanucleus.query.expression.Expression expr)`
`javax.jdo.PersistenceManager`	`getPersistenceManager()`
`static String`	`getQueryClassNameForClassName(String name)` Method to return the (simple) name of the query class for a specified class name.
`Boolean`	`getSerializeRead()`
`javax.jdo.JDOQLTypedQuery<T>`	`groupBy(javax.jdo.query.Expression... exprs)`
`javax.jdo.JDOQLTypedQuery<T>`	`having(javax.jdo.query.Expression expr)`
`javax.jdo.JDOQLTypedQuery<T>`	`ignoreCache(boolean flag)`
`javax.jdo.JDOQLTypedQuery<T>`	`includeSubclasses()`
`boolean`	`isUnmodifiable()`
`javax.jdo.query.ListExpression`	`listParameter(String name)`
`javax.jdo.query.MapExpression`	`mapParameter(String name)`
`javax.jdo.query.NumericExpression<?>`	`numericParameter(String name)`
`javax.jdo.JDOQLTypedQuery<T>`	`orderBy(javax.jdo.query.OrderExpression... exprs)`
`<P> javax.jdo.query.Expression<P>`	`parameter(String name, Class<P> type)`
`javax.jdo.JDOQLTypedQuery<T>`	`range(javax.jdo.query.Expression paramLowerInclExpr, javax.jdo.query.Expression paramUpperExclExpr)`
`javax.jdo.JDOQLTypedQuery<T>`	`range(long lowerIncl, long upperExcl)`
`javax.jdo.JDOQLTypedQuery<T>`	`range(javax.jdo.query.NumericExpression lowerInclExpr, javax.jdo.query.NumericExpression upperExclExpr)`
`javax.jdo.JDOQLTypedQuery<T>`	`result(boolean distinct, javax.jdo.query.Expression<?>... exprs)`
`javax.jdo.JDOQLTypedQuery<T>`	`saveAsNamedQuery(String name)`
`javax.jdo.JDOQLTypedQuery<T>`	`serializeRead(Boolean serialize)`
`javax.jdo.JDOQLTypedQuery<T>`	`set(javax.jdo.query.Expression expr, Object val)` Method to specify the update of a field of the candidate.
`javax.jdo.JDOQLTypedQuery<T>`	`setCandidates(Collection<T> candidates)`
`javax.jdo.JDOQLTypedQuery<T>`	`setParameter(javax.jdo.query.Expression paramExpr, Object value)`
`javax.jdo.JDOQLTypedQuery<T>`	`setParameter(String paramName, Object value)`
`javax.jdo.JDOQLTypedQuery<T>`	`setParameters(Map namedParamMap)`
`javax.jdo.query.StringExpression`	`stringParameter(String name)`
`<S> javax.jdo.JDOQLTypedSubquery<S>`	`subquery(Class<S> candidateClass, String candidateAlias)`
`javax.jdo.JDOQLTypedSubquery<T>`	`subquery(String candidateAlias)`
`javax.jdo.query.TimeExpression`	`timeParameter(String name)`
`javax.jdo.JDOQLTypedQuery<T>`	`unmodifiable()`
`long`	`update()` Extension method to provide bulk update capabilities (not part of JDO).
`<V> javax.jdo.query.Expression<V>`	`variable(String name, Class<V> type)`

Methods inherited from class org.datanucleus.api.jdo.query.AbstractJDOQLTypedQuery
discardCompiled, getCompilation, toString

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

Methods inherited from interface javax.jdo.JDOQLTypedQuery
toString

- Field Detail
  - fetchPlan
```
protected JDOFetchPlan fetchPlan
```
  - ignoreCache
```
protected boolean ignoreCache
```
  - serializeRead
```
protected Boolean serializeRead
```
  - datastoreReadTimeout
```
protected Integer datastoreReadTimeout
```
  - datastoreWriteTimeout
```
protected Integer datastoreWriteTimeout
```
  - extensions
```
protected Map<String,Object> extensions
```
  - candidates
```
protected Collection<T> candidates
```
  - parameterExprByName
```
protected Map<String,ExpressionImpl> parameterExprByName
```
    Map of parameter expression keyed by the name.
  - parameterValuesByName
```
protected Map<String,Object> parameterValuesByName
```
    Map of parameters keyed by their name/expression.
  - subqueries
```
protected transient Set<JDOQLTypedSubqueryImpl> subqueries
```
    Set of any subqueries used by this query.
  - internalQueries
```
protected transient Set<org.datanucleus.store.query.Query> internalQueries
```
    Internal queries generated by this typesafe query. Managed so that they can be closed. TODO Use just one?
- Constructor Detail
  - JDOQLTypedQueryImpl
```
public JDOQLTypedQueryImpl(javax.jdo.PersistenceManager pm,
                           Class<T> candidateClass)
```
    Constructor for a typesafe query.
    
    Parameters:
    
    pm - Persistence Manager
    
    candidateClass - The candidate class
- Method Detail
  - candidate
```
public javax.jdo.query.PersistableExpression candidate()
```
    Specified by:
    
    candidate in interface javax.jdo.JDOQLTypedQuery<T>
  - parameter
```
public <P> javax.jdo.query.Expression<P> parameter(String name,
                                                   Class<P> type)
```
    Specified by:
    
    parameter in interface javax.jdo.JDOQLTypedQuery<T>
  - stringParameter
```
public javax.jdo.query.StringExpression stringParameter(String name)
```
    Specified by:
    
    stringParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - characterParameter
```
public javax.jdo.query.CharacterExpression characterParameter(String name)
```
    Specified by:
    
    characterParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - numericParameter
```
public javax.jdo.query.NumericExpression<?> numericParameter(String name)
```
    Specified by:
    
    numericParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - dateParameter
```
public javax.jdo.query.DateExpression dateParameter(String name)
```
    Specified by:
    
    dateParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - timeParameter
```
public javax.jdo.query.TimeExpression timeParameter(String name)
```
    Specified by:
    
    timeParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - datetimeParameter
```
public javax.jdo.query.DateTimeExpression datetimeParameter(String name)
```
    Specified by:
    
    datetimeParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - collectionParameter
```
public javax.jdo.query.CollectionExpression collectionParameter(String name)
```
    Specified by:
    
    collectionParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - mapParameter
```
public javax.jdo.query.MapExpression mapParameter(String name)
```
    Specified by:
    
    mapParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - listParameter
```
public javax.jdo.query.ListExpression listParameter(String name)
```
    Specified by:
    
    listParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - variable
```
public <V> javax.jdo.query.Expression<V> variable(String name,
                                                  Class<V> type)
```
    Specified by:
    
    variable in interface javax.jdo.JDOQLTypedQuery<T>
  - excludeSubclasses
```
public javax.jdo.JDOQLTypedQuery<T> excludeSubclasses()
```
    Specified by:
    
    excludeSubclasses in interface javax.jdo.JDOQLTypedQuery<T>
  - includeSubclasses
```
public javax.jdo.JDOQLTypedQuery<T> includeSubclasses()
```
    Specified by:
    
    includeSubclasses in interface javax.jdo.JDOQLTypedQuery<T>
  - filter
```
public javax.jdo.JDOQLTypedQuery<T> filter(javax.jdo.query.BooleanExpression expr)
```
    Specified by:
    
    filter in interface javax.jdo.JDOQLTypedQuery<T>
  - groupBy
```
public javax.jdo.JDOQLTypedQuery<T> groupBy(javax.jdo.query.Expression... exprs)
```
    Specified by:
    
    groupBy in interface javax.jdo.JDOQLTypedQuery<T>
  - having
```
public javax.jdo.JDOQLTypedQuery<T> having(javax.jdo.query.Expression expr)
```
    Specified by:
    
    having in interface javax.jdo.JDOQLTypedQuery<T>
  - orderBy
```
public javax.jdo.JDOQLTypedQuery<T> orderBy(javax.jdo.query.OrderExpression... exprs)
```
    Specified by:
    
    orderBy in interface javax.jdo.JDOQLTypedQuery<T>
  - range
```
public javax.jdo.JDOQLTypedQuery<T> range(long lowerIncl,
                                          long upperExcl)
```
    Specified by:
    
    range in interface javax.jdo.JDOQLTypedQuery<T>
  - range
```
public javax.jdo.JDOQLTypedQuery<T> range(javax.jdo.query.NumericExpression lowerInclExpr,
                                          javax.jdo.query.NumericExpression upperExclExpr)
```
    Specified by:
    
    range in interface javax.jdo.JDOQLTypedQuery<T>
  - range
```
public javax.jdo.JDOQLTypedQuery<T> range(javax.jdo.query.Expression paramLowerInclExpr,
                                          javax.jdo.query.Expression paramUpperExclExpr)
```
    Specified by:
    
    range in interface javax.jdo.JDOQLTypedQuery<T>
  - subquery
```
public <S> javax.jdo.JDOQLTypedSubquery<S> subquery(Class<S> candidateClass,
                                                    String candidateAlias)
```
    Specified by:
    
    subquery in interface javax.jdo.JDOQLTypedQuery<T>
  - subquery
```
public javax.jdo.JDOQLTypedSubquery<T> subquery(String candidateAlias)
```
    Specified by:
    
    subquery in interface javax.jdo.JDOQLTypedQuery<T>
  - setParameters
```
public javax.jdo.JDOQLTypedQuery<T> setParameters(Map namedParamMap)
```
    Specified by:
    
    setParameters in interface javax.jdo.JDOQLTypedQuery<T>
  - setParameter
```
public javax.jdo.JDOQLTypedQuery<T> setParameter(javax.jdo.query.Expression paramExpr,
                                                 Object value)
```
    Specified by:
    
    setParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - setParameter
```
public javax.jdo.JDOQLTypedQuery<T> setParameter(String paramName,
                                                 Object value)
```
    Specified by:
    
    setParameter in interface javax.jdo.JDOQLTypedQuery<T>
  - setCandidates
```
public javax.jdo.JDOQLTypedQuery<T> setCandidates(Collection<T> candidates)
```
    Specified by:
    
    setCandidates in interface javax.jdo.JDOQLTypedQuery<T>
  - result
```
public javax.jdo.JDOQLTypedQuery<T> result(boolean distinct,
                                           javax.jdo.query.Expression<?>... exprs)
```
    Specified by:
    
    result in interface javax.jdo.JDOQLTypedQuery<T>
  - executeResultList
```
public <R> List<R> executeResultList(Class<R> resultCls)
```
    Specified by:
    
    executeResultList in interface javax.jdo.JDOQLTypedQuery<T>
  - executeResultUnique
```
public <R> R executeResultUnique(Class<R> resultCls)
```
    Specified by:
    
    executeResultUnique in interface javax.jdo.JDOQLTypedQuery<T>
  - executeResultList
```
public List executeResultList()
```
    Specified by:
    
    executeResultList in interface javax.jdo.JDOQLTypedQuery<T>
  - executeResultUnique
```
public Object executeResultUnique()
```
    Specified by:
    
    executeResultUnique in interface javax.jdo.JDOQLTypedQuery<T>
  - executeList
```
public List<T> executeList()
```
    Specified by:
    
    executeList in interface javax.jdo.JDOQLTypedQuery<T>
  - executeUnique
```
public T executeUnique()
```
    Specified by:
    
    executeUnique in interface javax.jdo.JDOQLTypedQuery<T>
  - getInternalQuery
```
protected org.datanucleus.store.query.Query getInternalQuery()
```
    Convenience method to generate an internal DataNucleus Query and apply the generic compilation to it.
    
    Returns:
    
    The internal DataNucleus query
  - executeInternalQuery
```
protected Object executeInternalQuery(org.datanucleus.store.query.Query internalQuery)
```
  - deletePersistentAll
```
public long deletePersistentAll()
```
    Specified by:
    
    deletePersistentAll in interface javax.jdo.JDOQLTypedQuery<T>
  - set
```
public javax.jdo.JDOQLTypedQuery<T> set(javax.jdo.query.Expression expr,
                                        Object val)
```
    Method to specify the update of a field of the candidate.
    
    Parameters:
    
    expr - Expression for field of the candidate
    
    val - The new value
    
    Returns:
    
    The query
  - update
```
public long update()
```
    Extension method to provide bulk update capabilities (not part of JDO).
    
    Returns:
    
    Number of instances that were updated
  - delete
```
public long delete()
```
    Extension method to provide bulk delete capabilities (not part of JDO). This differs from deletePersistentAll() in that it doesn't cascade to related objects (unless the datastore does that automatically), and that it doesn't attempt to update cached objects state to reflect the deletion.
    
    Returns:
    
    Number of instances that were deleted
  - getFetchPlan
```
public javax.jdo.FetchPlan getFetchPlan()
```
    Specified by:
    
    getFetchPlan in interface javax.jdo.JDOQLTypedQuery<T>
  - getPersistenceManager
```
public javax.jdo.PersistenceManager getPersistenceManager()
```
    Specified by:
    
    getPersistenceManager in interface javax.jdo.JDOQLTypedQuery<T>
  - close
```
public void close(Object result)
```
    Specified by:
    
    close in interface javax.jdo.JDOQLTypedQuery<T>
  - closeAll
```
public void closeAll()
```
    Specified by:
    
    closeAll in interface javax.jdo.JDOQLTypedQuery<T>
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - compile
```
public org.datanucleus.query.compiler.QueryCompilation compile(org.datanucleus.metadata.MetaDataManager mmgr,
                                                               org.datanucleus.ClassLoaderResolver clr)
```
    Method to compile the typesafe query.
    
    Overrides:
    
    compile in class AbstractJDOQLTypedQuery<T>
    
    Parameters:
    
    mmgr - Metadata manager
    
    clr - ClassLoader resolver
    
    Returns:
    
    The generic compilation
  - getQueryClassNameForClassName
```
public static String getQueryClassNameForClassName(String name)
```
    Method to return the (simple) name of the query class for a specified class name. Currently just returns "Q{className}"
    
    Parameters:
    
    name - Simple name of the class (without package)
    
    Returns:
    
    Simple name of the query class
  - getDatastoreReadTimeoutMillis
```
public Integer getDatastoreReadTimeoutMillis()
```
    Specified by:
    
    getDatastoreReadTimeoutMillis in interface javax.jdo.JDOQLTypedQuery<T>
  - datastoreReadTimeoutMillis
```
public javax.jdo.JDOQLTypedQuery<T> datastoreReadTimeoutMillis(Integer interval)
```
    Specified by:
    
    datastoreReadTimeoutMillis in interface javax.jdo.JDOQLTypedQuery<T>
  - getDatastoreWriteTimeoutMillis
```
public Integer getDatastoreWriteTimeoutMillis()
```
    Specified by:
    
    getDatastoreWriteTimeoutMillis in interface javax.jdo.JDOQLTypedQuery<T>
  - datastoreWriteTimeoutMillis
```
public javax.jdo.JDOQLTypedQuery<T> datastoreWriteTimeoutMillis(Integer interval)
```
    Specified by:
    
    datastoreWriteTimeoutMillis in interface javax.jdo.JDOQLTypedQuery<T>
  - getSerializeRead
```
public Boolean getSerializeRead()
```
    Specified by:
    
    getSerializeRead in interface javax.jdo.JDOQLTypedQuery<T>
  - serializeRead
```
public javax.jdo.JDOQLTypedQuery<T> serializeRead(Boolean serialize)
```
    Specified by:
    
    serializeRead in interface javax.jdo.JDOQLTypedQuery<T>
  - isUnmodifiable
```
public boolean isUnmodifiable()
```
    Specified by:
    
    isUnmodifiable in interface javax.jdo.JDOQLTypedQuery<T>
  - unmodifiable
```
public javax.jdo.JDOQLTypedQuery<T> unmodifiable()
```
    Specified by:
    
    unmodifiable in interface javax.jdo.JDOQLTypedQuery<T>
  - assertIsModifiable
```
protected void assertIsModifiable()
```
    Method to throw an exception if the query is currently not modifiable.
    
    Throws:
    
    org.datanucleus.exceptions.NucleusUserException - Thrown when it is unmodifiable
  - getIgnoreCache
```
public boolean getIgnoreCache()
```
    Specified by:
    
    getIgnoreCache in interface javax.jdo.JDOQLTypedQuery<T>
  - ignoreCache
```
public javax.jdo.JDOQLTypedQuery<T> ignoreCache(boolean flag)
```
    Specified by:
    
    ignoreCache in interface javax.jdo.JDOQLTypedQuery<T>
  - extension
```
public javax.jdo.JDOQLTypedQuery<T> extension(String key,
                                              Object value)
```
    Specified by:
    
    extension in interface javax.jdo.JDOQLTypedQuery<T>
  - extensions
```
public javax.jdo.JDOQLTypedQuery<T> extensions(Map values)
```
    Specified by:
    
    extensions in interface javax.jdo.JDOQLTypedQuery<T>
  - cancelAll
```
public void cancelAll()
```
    Specified by:
    
    cancelAll in interface javax.jdo.JDOQLTypedQuery<T>
  - cancel
```
public void cancel(Thread thread)
```
    Specified by:
    
    cancel in interface javax.jdo.JDOQLTypedQuery<T>
  - saveAsNamedQuery
```
public javax.jdo.JDOQLTypedQuery<T> saveAsNamedQuery(String name)
```
    Specified by:
    
    saveAsNamedQuery in interface javax.jdo.JDOQLTypedQuery<T>
  - getJDOQLForExpression
```
public String getJDOQLForExpression(org.datanucleus.query.expression.Expression expr)
```
    Overrides:
    
    getJDOQLForExpression in class AbstractJDOQLTypedQuery<T>

Class JDOQLTypedQueryImpl<T>

Field Summary

Fields inherited from class org.datanucleus.api.jdo.query.AbstractJDOQLTypedQuery

Fields inherited from interface javax.jdo.JDOQLTypedQuery

Constructor Summary

Method Summary

Methods inherited from class org.datanucleus.api.jdo.query.AbstractJDOQLTypedQuery

Methods inherited from class java.lang.Object

Methods inherited from interface javax.jdo.JDOQLTypedQuery

Field Detail

fetchPlan

ignoreCache

serializeRead

datastoreReadTimeout

datastoreWriteTimeout

extensions

candidates

parameterExprByName

parameterValuesByName

subqueries

internalQueries

Constructor Detail

JDOQLTypedQueryImpl

Method Detail

candidate

parameter

stringParameter

characterParameter

numericParameter

dateParameter

timeParameter

datetimeParameter

collectionParameter

mapParameter

listParameter

variable

excludeSubclasses

includeSubclasses

filter

groupBy

having

orderBy

range

range

range

subquery

subquery

setParameters

setParameter

setParameter

setCandidates

result

executeResultList

executeResultUnique

executeResultList

executeResultUnique

executeList

executeUnique

getInternalQuery

executeInternalQuery

deletePersistentAll

set

update

delete

getFetchPlan

getPersistenceManager

close

closeAll

close

compile

getQueryClassNameForClassName

getDatastoreReadTimeoutMillis

datastoreReadTimeoutMillis

getDatastoreWriteTimeoutMillis

datastoreWriteTimeoutMillis

getSerializeRead

serializeRead

isUnmodifiable

unmodifiable

assertIsModifiable