org.datanucleus.store.query

Class AbstractJPQLQuery

java.lang.Object

org.datanucleus.store.query.Query

org.datanucleus.store.query.AbstractJavaQuery

org.datanucleus.store.query.AbstractJPQLQuery

All Implemented Interfaces:

Serializable, ExecutionContextListener

public abstract class AbstractJPQLQuery
extends AbstractJavaQuery

Abstract representation of a JPQL query used by DataNucleus. The query can be specified via method calls, or via a single-string form.

See Also:

Query, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.datanucleus.store.query.Query

Query.SubqueryDefinition

Field Summary

Fields inherited from class org.datanucleus.store.query.AbstractJavaQuery

candidateCollection, singleString

Fields inherited from class org.datanucleus.store.query.Query

BULK_DELETE, BULK_UPDATE, candidateClass, candidateClassName, clr, compilation, ec, explicitParameters, explicitVariables, EXTENSION_CHECK_UNUSED_PARAMETERS, EXTENSION_CLOSE_RESULTS_AT_EC_CLOSE, EXTENSION_COMPILATION_CACHED, EXTENSION_EVALUATE_IN_MEMORY, EXTENSION_FLUSH_BEFORE_EXECUTION, EXTENSION_LOAD_RESULTS_AT_COMMIT, EXTENSION_MULTITHREAD, EXTENSION_RESULT_CACHE_TYPE, EXTENSION_RESULT_SIZE_METHOD, EXTENSION_RESULTS_CACHED, EXTENSION_USE_FETCH_PLAN, extensions, filter, from, fromInclNo, fromInclParam, grouping, having, ignoreCache, implicitParameters, imports, inputParameters, ordering, OTHER, parameterNames, parsedImports, queryResults, range, result, resultClass, resultClassName, resultDistinct, SELECT, storeMgr, subclasses, subqueries, tasks, toExclNo, toExclParam, type, unique, unmodifiable, update

Constructor Summary

Constructors

Constructor and Description
AbstractJPQLQuery(StoreManager storeMgr, ExecutionContext ec) Constructor.
AbstractJPQLQuery(StoreManager storeMgr, ExecutionContext ec, AbstractJPQLQuery q) Constructs a new query instance having the same criteria as the given query.
AbstractJPQLQuery(StoreManager storeMgr, ExecutionContext ec, String query) Constructor for a JPQL query where the query is specified using the "Single-String" format.

Method Summary

Modifier and Type	Method and Description
void	compileGeneric(Map parameterValues) Method to generate the generic compilation of this query.
protected void	compileInternal(Map parameterValues) Method to compile the JPQL query.
protected void	compileSubqueries(Map<String,Query.SubqueryDefinition> subqueryMap, QueryCompilation parentCompilation, JavaQueryCompiler parentCompiler, Map parameterValues) Recursively compile the subqueries
String	getLanguage() Accessor for the query language.
protected String	getQueryCacheKey() Method to get key for query cache
String	getSingleStringQuery() Method to take the defined parameters for the query and form a single string.
Class	resolveClassDeclaration(String classDecl) Utility to resolve the declaration to a particular class.
void	setResult(String result) Set the result for the results.

Methods inherited from class org.datanucleus.store.query.AbstractJavaQuery

dereferenceFilter, discardCompiled, evaluateInMemory, performDeletePersistentAll, setCandidates, setCandidates, toString

Methods inherited from class org.datanucleus.store.query.Query

addExtension, addSubquery, applyImplicitParameterValueToCompilation, applyImplicitParameterValueToSubqueries, assertIsModifiable, assertIsOpen, assertSupportsCancel, cancel, cancel, cancelTaskObject, checkForMissingParameters, checkParameterTypesAgainstCompilation, checkUnusedParameters, close, closeAll, compile, declareExplicitParameters, declareExplicitVariables, declareImports, deepFindSymbolForParameterInCompilation, deletePersistentAll, deletePersistentAll, deletePersistentAll, deregisterTask, equals, execute, executeQuery, executeWithArray, executeWithMap, executionContextClosing, getBooleanExtensionProperty, getCandidateClass, getCandidateClassMetaData, getCandidateClassName, getCompilation, getDatastoreReadTimeoutMillis, getDatastoreWriteTimeoutMillis, getExecutionContext, getExplicitParameters, getExplicitVariables, getExtension, getExtensions, getFetchPlan, getFilter, getFrom, getGrouping, getHaving, getIgnoreCache, getImplicitParameters, getImports, getInputParameters, getNativeQuery, getOrdering, getParameterMapForValues, getParsedImports, getQueryManager, getRange, getRangeFromIncl, getRangeFromInclParam, getRangeToExcl, getRangeToExclParam, getResult, getResultClass, getResultClassName, getResultDistinct, getSerializeRead, getStoreManager, getStringExtensionProperty, getSubqueryForVariable, getSupportedExtensions, getType, getUpdate, hashCode, hasSubqueryForVariable, isCompiled, isSubclasses, isUnique, isUnmodifiable, performExecute, prepareDatastore, processesRangeInDatastoreQuery, registerTask, setCacheResults, setCandidateClass, setCandidateClassName, setCompilation, setDatastoreReadTimeoutMillis, setDatastoreWriteTimeoutMillis, setExtensions, setFetchPlan, setFilter, setFrom, setGrouping, setHaving, setIgnoreCache, setImplicitParameter, setImplicitParameter, setOrdering, setRange, setRange, setResultClass, setResultClassName, setResultDistinct, setResultMetaData, setSerializeRead, setSubclasses, setType, setUnique, setUnmodifiable, setUpdate, shouldReturnSingleRow, supportsTimeout, useCaching, useFetchPlan, useResultsCaching

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractJPQLQuery

public AbstractJPQLQuery(StoreManager storeMgr,
                         ExecutionContext ec)

Constructor.

Parameters:

storeMgr - StoreManager for this query

ec - ExecutionContext

AbstractJPQLQuery

public AbstractJPQLQuery(StoreManager storeMgr,
                         ExecutionContext ec,
                         AbstractJPQLQuery q)

Constructs a new query instance having the same criteria as the given query.

Parameters:

storeMgr - StoreManager for this query

ec - ExecutionContext

q - The query from which to copy criteria.

AbstractJPQLQuery

public AbstractJPQLQuery(StoreManager storeMgr,
                         ExecutionContext ec,
                         String query)

Constructor for a JPQL query where the query is specified using the "Single-String" format.

Parameters:

storeMgr - StoreManager for this query

ec - ExecutionContext

query - The query string

Method Detail

setResult

public void setResult(String result)

Set the result for the results.

Overrides:

setResult in class Query

Parameters:

result - Optional keyword "distinct" followed by comma-separated list of result expressions or a result class

getQueryCacheKey

protected String getQueryCacheKey()

Method to get key for query cache

Returns:

The cache key

getSingleStringQuery

public String getSingleStringQuery()

Method to take the defined parameters for the query and form a single string. This is used to print out the query for logging.

Specified by:

getSingleStringQuery in class AbstractJavaQuery

Returns:

The single string

compileGeneric

public void compileGeneric(Map parameterValues)

Description copied from class: AbstractJavaQuery

Method to generate the generic compilation of this query.

Specified by:

compileGeneric in class AbstractJavaQuery

Parameters:

parameterValues - Values for any parameters

compileInternal

protected void compileInternal(Map parameterValues)

Method to compile the JPQL query. This implementation assumes that we are using the "generic" JPQL compiler in org.datanucleus.query.compiler. If not then override this method. Will populate the "compilation" class variable.

Specified by:

compileInternal in class Query

Parameters:

parameterValues - Map of param values keyed by param name.

compileSubqueries

protected void compileSubqueries(Map<String,Query.SubqueryDefinition> subqueryMap,
                                 QueryCompilation parentCompilation,
                                 JavaQueryCompiler parentCompiler,
                                 Map parameterValues)

Recursively compile the subqueries

Parameters:

subqueryMap - The subquery definition map

parentCompilation - The parent compilation

parentCompiler - The parent compiler

parameterValues - The parameters map

resolveClassDeclaration

public Class resolveClassDeclaration(String classDecl)

Utility to resolve the declaration to a particular class. Takes the passed in name, together with the defined import declarations and returns the class represented by the declaration.

Overrides:

resolveClassDeclaration in class Query

Parameters:

classDecl - The declaration

Returns:

The class it resolves to (if any)

Throws:

NucleusUserException - Thrown if the class cannot be resolved.

getLanguage

public String getLanguage()

Accessor for the query language.

Overrides:

getLanguage in class Query

Returns:

Query language