org.datanucleus.query.compiler

Class JPQLCompiler

java.lang.Object

org.datanucleus.query.compiler.JavaQueryCompiler

org.datanucleus.query.compiler.JPQLCompiler

All Implemented Interfaces:

SymbolResolver

public class JPQLCompiler
extends JavaQueryCompiler

Implementation of a compiler for JPQL (JSR0220, JSR0317).

Field Summary

Fields inherited from class org.datanucleus.query.compiler.JavaQueryCompiler

candidateAlias, candidateAliasOrig, candidateClass, candidates, caseSensitiveAliases, clr, filter, from, grouping, having, imports, JOIN_INNER, JOIN_INNER_FETCH, JOIN_OUTER, JOIN_OUTER_FETCH, JOIN_OUTER_FETCH_RIGHT, JOIN_OUTER_RIGHT, metaDataManager, options, ordering, parameters, parameterSubstitutionNumber, parameterSubtitutionMap, parentCompiler, parser, queryMgr, result, symtbl, update, variables

Constructor Summary

Constructors

Constructor and Description
JPQLCompiler(PersistenceNucleusContext nucCtx, ClassLoaderResolver clr, String from, Class candidateClass, Collection candidates, String filter, Imports imports, String ordering, String result, String grouping, String having, String params, String update)

Method Summary

Modifier and Type	Method and Description
boolean	caseSensitiveSymbolNames() Whether names of symbols are case-sensitive (e.g JDOQL returns true, but JPQL returns false).
QueryCompilation	compile(Map parameters, Map subqueryMap) Method to compile the query, and return the compiled results.
String	getLanguage() Accessor for the query language name.
protected boolean	isKeyword(String name) Method to return if the supplied name is a keyword.
Class	resolveClass(String className) Method to perform a lookup of the class name from the input name.
boolean	supportsImplicitVariables() Whether we should accept implicit variables in the query.

Methods inherited from class org.datanucleus.query.compiler.JavaQueryCompiler

compileCandidatesParametersVariables, compileFilter, compileFrom, compileGrouping, compileHaving, compileOrdering, compileResult, compileUpdate, getPrimaryClass, getType, setLinkToParentQuery, setOption, swapCandidateAliasNodeName, swapSubqueryParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

JPQLCompiler

public JPQLCompiler(PersistenceNucleusContext nucCtx,
                    ClassLoaderResolver clr,
                    String from,
                    Class candidateClass,
                    Collection candidates,
                    String filter,
                    Imports imports,
                    String ordering,
                    String result,
                    String grouping,
                    String having,
                    String params,
                    String update)

Method Detail

compile

public QueryCompilation compile(Map parameters,
                                Map subqueryMap)

Method to compile the query, and return the compiled results.

Specified by:

compile in class JavaQueryCompiler

Parameters:

parameters - the parameter map of values keyed by param name

subqueryMap - Map of subquery variables, keyed by the subquery name

Returns:

The compiled query

resolveClass

public Class resolveClass(String className)

Method to perform a lookup of the class name from the input name. Makes use of the query "imports" and the lookup to "entity name".

Specified by:

resolveClass in interface SymbolResolver

Overrides:

resolveClass in class JavaQueryCompiler

Parameters:

className - Name of the class

Returns:

The class corresponding to this name

Throws:

ClassNotResolvedException - thrown if not resolvable using imports or entity name

supportsImplicitVariables

public boolean supportsImplicitVariables()

Description copied from interface: SymbolResolver

Whether we should accept implicit variables in the query. JDOQL supports variables, yet JPQL doesn't. Also in JDOQL if the user supplies some explicit variables then it doesn't allow implicit variables.

Returns:

Whether to support implicit variables

caseSensitiveSymbolNames

public boolean caseSensitiveSymbolNames()

Description copied from interface: SymbolResolver

Whether names of symbols are case-sensitive (e.g JDOQL returns true, but JPQL returns false).

Returns:

Whether case sensitive

getLanguage

public String getLanguage()

Accessor for the query language name.

Specified by:

getLanguage in class JavaQueryCompiler

Returns:

Name of the query language.

isKeyword

protected boolean isKeyword(String name)

Method to return if the supplied name is a keyword. Keywords can only appear at particular places in a query so we need to detect for valid queries.

Specified by:

isKeyword in class JavaQueryCompiler

Parameters:

name - The name

Returns:

Whether it is a keyword