org.datanucleus.api.jdo

Class JDOQuery

java.lang.Object

org.datanucleus.api.jdo.JDOQuery

All Implemented Interfaces:

Serializable, AutoCloseable, javax.jdo.Query

public class JDOQuery
extends Object
implements javax.jdo.Query, AutoCloseable

Wrapper for JDO Query class. Stores the PM the query is executed against, the internal query, and the query language. The language is stored since it is referenced by the JDO API and so we don't have to embody knowledge of which internal query type is for which language (could be moved to the internal query).

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.jdo.Query

JDOQL, SQL

Constructor Summary

Constructors

Constructor and Description
JDOQuery(javax.jdo.PersistenceManager pm, org.datanucleus.store.query.Query query, String language) Constructor for a query used by JDO.

Method Summary

Modifier and Type	Method and Description
void	addExtension(String key, Object value) Method to add an extension to the query.
void	addSubquery(javax.jdo.Query sub, String variableDecl, String candidateExpr) Add a subquery to this query.
void	addSubquery(javax.jdo.Query sub, String variableDecl, String candidateExpr, Map parameters) Add a subquery to this query.
void	addSubquery(javax.jdo.Query sub, String variableDecl, String candidateExpr, String... parameters) Add a subquery to this query.
void	addSubquery(javax.jdo.Query sub, String variableDecl, String candidateExpr, String parameter) Add a subquery to this query.
void	cancel(Thread thr) Method to cancel the executing query for the supplied thread.
void	cancelAll() Method to cancel any executing queries.
void	close()
void	close(Object queryResult) Close the query result.
void	closeAll() Close all query results for this query.
void	compile() Compile the query.
void	declareImports(String imports) Declare any imports for the query.
void	declareParameters(String parameters) Declare any parameters for the query.
void	declareVariables(String variables) Declare any variables for the query.
long	deletePersistentAll() Execute the query deleting all instances found.
long	deletePersistentAll(Map parameters) Execute the query deleting all instances found.
long	deletePersistentAll(Object... parameters) Execute the query deleting all instances found.
Object	execute() Execute the query.
Object	execute(Object p1) Execute the query.
Object	execute(Object p1, Object p2) Execute the query.
Object	execute(Object p1, Object p2, Object p3) Execute the query.
Object	executeWithArray(Object... parameterValues) Execute the query.
Object	executeWithMap(Map parameters) Execute the query.
javax.jdo.Query	filter(String filter)
Integer	getDatastoreReadTimeoutMillis() Accessor for the datastore read timeout.
Integer	getDatastoreWriteTimeoutMillis() Accessor for the datastore write timeout.
javax.jdo.FetchPlan	getFetchPlan() Accessor for the fetch plan to use.
boolean	getIgnoreCache() Accessor for the ignore cache setting
org.datanucleus.store.query.Query	getInternalQuery() Accessor for the internal query.
String	getLanguage() Accessor for the query language.
Object	getNativeQuery() Accessor for the native query invoked by this query (if known at this time and supported by the store plugin).
javax.jdo.PersistenceManager	getPersistenceManager() Accessor for the PersistenceManager.
Boolean	getSerializeRead() Accessor for whether to serialise any read objects in this query.
javax.jdo.Query	groupBy(String grouping)
javax.jdo.Query	having(String having)
boolean	isUnmodifiable() Accessor for whether the query is modifiable.
javax.jdo.Query	orderBy(String ordering)
javax.jdo.Query	range(long fromIncl, long toExcl)
javax.jdo.Query	range(String range)
javax.jdo.Query	saveAsNamedQuery(String name) Save this query as a named query with the specified name.
void	setCandidates(Collection pcs) Set the candidates for the query.
void	setCandidates(javax.jdo.Extent extent) Set the candidates for the query.
void	setClass(Class candidateClass) Set the candidate class for the query.
void	setDatastoreReadTimeoutMillis(Integer timeout) Set the datastore read timeout.
void	setDatastoreWriteTimeoutMillis(Integer timeout) Set the datastore write timeout.
void	setExtensions(Map extensions) Set the extensions for the query.
void	setFilter(String filter) Set the filter for the query.
void	setGrouping(String grouping) Set the grouping for the query.
void	setIgnoreCache(boolean ignoreCache) Set the ignore cache setting for the query.
void	setOrdering(String ordering) Set the ordering for the query.
void	setRange(long fromIncl, long toExcl) Set the range for the query.
void	setRange(String range) Set the range for the query.
void	setResult(String result) Set the result for the query.
void	setResultClass(Class result_cls) Set the result class for the query.
void	setSerializeRead(Boolean serialize) Mutator for whether to serialise any read objects.
void	setUnique(boolean unique) Set whether to expect a unique result.
void	setUnmodifiable() Set the query to be unmodifiable.
String	toString() Convenience method to return the query in string form.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDOQuery

public JDOQuery(javax.jdo.PersistenceManager pm,
                org.datanucleus.store.query.Query query,
                String language)

Constructor for a query used by JDO.

Parameters:

pm - PersistenceManager

query - Underlying query

language - Query language

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

close

public void close(Object queryResult)

Close the query result.

Specified by:

close in interface javax.jdo.Query

Parameters:

queryResult - Query result

closeAll

public void closeAll()

Close all query results for this query.

Specified by:

closeAll in interface javax.jdo.Query

compile

public void compile()

Compile the query.

Specified by:

compile in interface javax.jdo.Query

declareImports

public void declareImports(String imports)

Declare any imports for the query.

Specified by:

declareImports in interface javax.jdo.Query

Parameters:

imports - The imports

declareParameters

public void declareParameters(String parameters)

Declare any parameters for the query.

Specified by:

declareParameters in interface javax.jdo.Query

Parameters:

parameters - The parameters

declareVariables

public void declareVariables(String variables)

Declare any variables for the query.

Specified by:

declareVariables in interface javax.jdo.Query

Parameters:

variables - The variables

deletePersistentAll

public long deletePersistentAll()

Execute the query deleting all instances found.

Specified by:

deletePersistentAll in interface javax.jdo.Query

Returns:

Number of deleted instances

deletePersistentAll

public long deletePersistentAll(Object... parameters)

Execute the query deleting all instances found.

Specified by:

deletePersistentAll in interface javax.jdo.Query

Parameters:

parameters - Parameters to use when executing

Returns:

Number of deleted instances

deletePersistentAll

public long deletePersistentAll(Map parameters)

Execute the query deleting all instances found.

Specified by:

deletePersistentAll in interface javax.jdo.Query

Parameters:

parameters - Parameters to use when executing

Returns:

Number of deleted instances

execute

public Object execute()

Execute the query.

Specified by:

execute in interface javax.jdo.Query

Returns:

The results

execute

public Object execute(Object p1)

Execute the query.

Specified by:

execute in interface javax.jdo.Query

Parameters:

p1 - First param value

Returns:

The results

execute

public Object execute(Object p1,
                      Object p2)

Execute the query.

Specified by:

execute in interface javax.jdo.Query

Parameters:

p1 - First param value

p2 - Second param value

Returns:

The results

execute

public Object execute(Object p1,
                      Object p2,
                      Object p3)

Execute the query.

Specified by:

execute in interface javax.jdo.Query

Parameters:

p1 - First param value

p2 - Second param value

p3 - Third param value

Returns:

The results

executeWithArray

public Object executeWithArray(Object... parameterValues)

Execute the query.

Specified by:

executeWithArray in interface javax.jdo.Query

Parameters:

parameterValues - Param values

Returns:

The results

executeWithMap

public Object executeWithMap(Map parameters)

Execute the query.

Specified by:

executeWithMap in interface javax.jdo.Query

Parameters:

parameters - Param values

Returns:

The results

cancelAll

public void cancelAll()

Method to cancel any executing queries.

Specified by:

cancelAll in interface javax.jdo.Query

Throws:

javax.jdo.JDOUnsupportedOptionException - if the datastore doesn't support cancellation of queries

cancel

public void cancel(Thread thr)

Method to cancel the executing query for the supplied thread.

Specified by:

cancel in interface javax.jdo.Query

Throws:

javax.jdo.JDOUnsupportedOptionException - if the datastore doesn't support cancellation of queries

setCandidates

public void setCandidates(javax.jdo.Extent extent)

Set the candidates for the query.

Specified by:

setCandidates in interface javax.jdo.Query

Parameters:

extent - Extent defining the candidates

setCandidates

public void setCandidates(Collection pcs)

Set the candidates for the query.

Specified by:

setCandidates in interface javax.jdo.Query

Parameters:

pcs - PC candidates

setClass

public void setClass(Class candidateClass)

Set the candidate class for the query.

Specified by:

setClass in interface javax.jdo.Query

Parameters:

candidateClass - Candidate class

addExtension

public void addExtension(String key,
                         Object value)

Method to add an extension to the query.

Specified by:

addExtension in interface javax.jdo.Query

Parameters:

key - Key for the extension

value - Value for the extension

setExtensions

public void setExtensions(Map extensions)

Set the extensions for the query.

Specified by:

setExtensions in interface javax.jdo.Query

Parameters:

extensions - The extensions

getFetchPlan

public javax.jdo.FetchPlan getFetchPlan()

Accessor for the fetch plan to use.

Specified by:

getFetchPlan in interface javax.jdo.Query

Returns:

The fetch plan

setFilter

public void setFilter(String filter)

Set the filter for the query.

Specified by:

setFilter in interface javax.jdo.Query

Parameters:

filter - The query filter

setGrouping

public void setGrouping(String grouping)

Set the grouping for the query.

Specified by:

setGrouping in interface javax.jdo.Query

Parameters:

grouping - The grouping

getIgnoreCache

public boolean getIgnoreCache()

Accessor for the ignore cache setting

Specified by:

getIgnoreCache in interface javax.jdo.Query

Returns:

Ignore cache

setIgnoreCache

public void setIgnoreCache(boolean ignoreCache)

Set the ignore cache setting for the query.

Specified by:

setIgnoreCache in interface javax.jdo.Query

Parameters:

ignoreCache - The ignore cache setting

setOrdering

public void setOrdering(String ordering)

Set the ordering for the query.

Specified by:

setOrdering in interface javax.jdo.Query

Parameters:

ordering - The ordering

getPersistenceManager

public javax.jdo.PersistenceManager getPersistenceManager()

Accessor for the PersistenceManager.

Specified by:

getPersistenceManager in interface javax.jdo.Query

Returns:

PM

setRange

public void setRange(String range)

Set the range for the query.

Specified by:

setRange in interface javax.jdo.Query

Parameters:

range - The range specification

setRange

public void setRange(long fromIncl,
                     long toExcl)

Set the range for the query.

Specified by:

setRange in interface javax.jdo.Query

Parameters:

fromIncl - From range inclusive

toExcl - To range exclusive

setResult

public void setResult(String result)

Set the result for the query.

Specified by:

setResult in interface javax.jdo.Query

Parameters:

result - Result clause

setResultClass

public void setResultClass(Class result_cls)

Set the result class for the query.

Specified by:

setResultClass in interface javax.jdo.Query

Parameters:

result_cls - Result class

setDatastoreReadTimeoutMillis

public void setDatastoreReadTimeoutMillis(Integer timeout)

Set the datastore read timeout.

Specified by:

setDatastoreReadTimeoutMillis in interface javax.jdo.Query

Parameters:

timeout - Timeout interval (millisecs)

getDatastoreReadTimeoutMillis

public Integer getDatastoreReadTimeoutMillis()

Accessor for the datastore read timeout.

Specified by:

getDatastoreReadTimeoutMillis in interface javax.jdo.Query

Returns:

Timeout (if defined)

setDatastoreWriteTimeoutMillis

public void setDatastoreWriteTimeoutMillis(Integer timeout)

Set the datastore write timeout.

Specified by:

setDatastoreWriteTimeoutMillis in interface javax.jdo.Query

Parameters:

timeout - Timeout interval (millisecs)

getDatastoreWriteTimeoutMillis

public Integer getDatastoreWriteTimeoutMillis()

Accessor for the datastore write timeout.

Specified by:

getDatastoreWriteTimeoutMillis in interface javax.jdo.Query

Returns:

Timeout (if defined)

setUnique

public void setUnique(boolean unique)

Set whether to expect a unique result.

Specified by:

setUnique in interface javax.jdo.Query

Parameters:

unique - Whether results are unique

isUnmodifiable

public boolean isUnmodifiable()

Accessor for whether the query is modifiable.

Specified by:

isUnmodifiable in interface javax.jdo.Query

Returns:

Whether it is modifiable

setUnmodifiable

public void setUnmodifiable()

Set the query to be unmodifiable.

Specified by:

setUnmodifiable in interface javax.jdo.Query

addSubquery

public void addSubquery(javax.jdo.Query sub,
                        String variableDecl,
                        String candidateExpr)

Add a subquery to this query.

Specified by:

addSubquery in interface javax.jdo.Query

Parameters:

sub - the subquery to add to this Query

variableDecl - the name of the variable in the outer query to bind the results of the subquery

candidateExpr - the candidate collection of the subquery as an expression using terms of the outer query

addSubquery

public void addSubquery(javax.jdo.Query sub,
                        String variableDecl,
                        String candidateExpr,
                        String parameter)

Add a subquery to this query. The String version of the method binds the named expression to the parameter implictly or explicitly declared in the subquery.

Specified by:

addSubquery in interface javax.jdo.Query

Parameters:

sub - the subquery to add to this Query

variableDecl - the name of the variable to be used in this Query

candidateExpr - the candidate collection to apply to the subquery

parameter - the expression from the outer query to bind the parameter in the subquery

addSubquery

public void addSubquery(javax.jdo.Query sub,
                        String variableDecl,
                        String candidateExpr,
                        String... parameters)

Add a subquery to this query. The String version of the method binds the named expression to the parameter implictly or explicitly declared in the subquery.

Specified by:

addSubquery in interface javax.jdo.Query

Parameters:

sub - the subquery to add to this Query

variableDecl - the name of the variable to be used in this Query

candidateExpr - the candidate collection to apply to the subquery

parameters - the expressions from the outer query to bind the parameter in the subquery

addSubquery

public void addSubquery(javax.jdo.Query sub,
                        String variableDecl,
                        String candidateExpr,
                        Map parameters)

Add a subquery to this query. The String version of the method binds the named expression to the parameter implictly or explicitly declared in the subquery.

Specified by:

addSubquery in interface javax.jdo.Query

Parameters:

sub - the subquery to add to this Query

variableDecl - the name of the variable to be used in this Query

candidateExpr - the candidate collection to apply to the subquery

parameters - the expressions from the outer query to bind the parameter in the subquery

getSerializeRead

public Boolean getSerializeRead()

Accessor for whether to serialise any read objects in this query.

Specified by:

getSerializeRead in interface javax.jdo.Query

Returns:

The setting for whether to serialise any read objects

setSerializeRead

public void setSerializeRead(Boolean serialize)

Mutator for whether to serialise any read objects.

Specified by:

setSerializeRead in interface javax.jdo.Query

Parameters:

serialize - Whether to serialise any read objects in this query.

getInternalQuery

public org.datanucleus.store.query.Query getInternalQuery()

Accessor for the internal query.

Returns:

Internal query

getLanguage

public String getLanguage()

Accessor for the query language.

Returns:

Query language

saveAsNamedQuery

public javax.jdo.Query saveAsNamedQuery(String name)

Save this query as a named query with the specified name.

Parameters:

name - The name to refer to it under

Returns:

This query

toString

public String toString()

Convenience method to return the query in string form.

Overrides:

toString in class Object

Returns:

Stringifier method

getNativeQuery

public Object getNativeQuery()

Accessor for the native query invoked by this query (if known at this time and supported by the store plugin).

Returns:

The native query (e.g for RDBMS this is the SQL).

filter

public javax.jdo.Query filter(String filter)

groupBy

public javax.jdo.Query groupBy(String grouping)

having

public javax.jdo.Query having(String having)

orderBy

public javax.jdo.Query orderBy(String ordering)

range

public javax.jdo.Query range(long fromIncl,
                             long toExcl)

range

public javax.jdo.Query range(String range)