Class DeclarationResolver
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.resolver.Resolver
-
- org.eclipse.persistence.jpa.jpql.tools.resolver.DeclarationResolver
-
- Direct Known Subclasses:
EclipseLinkDeclarationResolver
public class DeclarationResolver extends Resolver
ThisResolver
is responsible to visit the current query (which is either the top-level query or a subquery) and gathers the information from the declaration clause. For a SELECT or DELETE clause, the information will be retrieved from the FROM clause. For anUDPATE
clause, it will be retrieved from the unique identification range variable declaration.- Since:
- 2.3
- Version:
- 2.5
- Author:
- Pascal Filion
-
-
Constructor Summary
Constructors Constructor Description DeclarationResolver(DeclarationResolver parent, JPQLQueryContext queryContext)
Creates a newDeclarationResolver
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRangeVariableDeclaration(String entityName, String variableName)
Registers a range variable declaration that will be used when a JPQL fragment is parsed.void
convertUnqualifiedDeclaration(Declaration declaration, String outerVariableName)
Converts the givenDeclaration
from being set as a range variable declaration to a path expression declaration.void
dispose()
Disposes the internal data.Declaration
getDeclaration(String variableName)
Retrieves theDeclaration
for which the given variable name is used to navigate to the "root" object.List<Declaration>
getDeclarations()
Returns the ordered list ofDeclarations
.DeclarationResolver
getParent()
Returns the parent of thisResolver
.IQuery
getQuery()
Returns the external form representing the JPQL query.Resolver
getResolver(String variableName)
Retrieves theResolver
mapped with the given identification variable.Set<String>
getResultVariables()
Returns the variables that got defined in the select expression.Map<IdentificationVariable,String>
getResultVariablesMap()
Returns the map of result variables that got used to define a select expression.boolean
hasJoins()
Determines whether the JPQL expression has JOIN expressions.boolean
isCollectionIdentificationVariable(String variableName)
Determines whether the given identification variable is defining a JOIN expression or in aIN
expressions for a collection-valued field.boolean
isRangeIdentificationVariable(String variableName)
Determines whether the given variable name is an identification variable name mapping an entity.boolean
isResultVariable(String variable)
Determines if the given variable is a result variable.void
populate(Expression expression)
Visits the current query (which is either the top-level query or a subquery) and gathers the information from the declaration clause.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.resolver.Resolver
addChild, getChild, getManagedType, getMapping, getParentManagedType, getParentMapping, getParentType, getParentTypeDeclaration, getProvider, getType, getType, getType, getTypeDeclaration, getTypeHelper, getTypeRepository, isNullAllowed, setNullAllowed
-
-
-
-
Constructor Detail
-
DeclarationResolver
public DeclarationResolver(DeclarationResolver parent, JPQLQueryContext queryContext)
Creates a newDeclarationResolver
.- Parameters:
parent
- The parent resolver if this is used for a subquery or null if it's used for the top-level queryqueryContext
- The context used to query information about the query
-
-
Method Detail
-
addRangeVariableDeclaration
public void addRangeVariableDeclaration(String entityName, String variableName)
Registers a range variable declaration that will be used when a JPQL fragment is parsed.- Parameters:
entityName
- The name of the entity to be accessible with the given variable namevariableName
- The identification variable used to navigate to the entity
-
convertUnqualifiedDeclaration
public void convertUnqualifiedDeclaration(Declaration declaration, String outerVariableName)
Converts the givenDeclaration
from being set as a range variable declaration to a path expression declaration.In this query "
UPDATE Employee SET firstName = 'MODIFIED' WHERE (SELECT COUNT(m) FROM managedEmployees m) > 0
" managedEmployees is an unqualified collection-valued path expression (employee.managedEmployees
).- Parameters:
declaration
- TheDeclaration
that was parsed to range over an abstract schema name but is actually ranging over a path expressionouterVariableName
- The identification variable coming from the parent identification variable declaration
-
dispose
public void dispose()
Disposes the internal data.
-
getDeclaration
public Declaration getDeclaration(String variableName)
Retrieves theDeclaration
for which the given variable name is used to navigate to the "root" object.- Parameters:
variableName
- The name of the identification variable that is used to navigate a "root" object- Returns:
- The
Declaration
containing the information about the identification variable declaration - Since:
- 2.5
-
getDeclarations
public List<Declaration> getDeclarations()
Returns the ordered list ofDeclarations
.- Returns:
- The
Declarations
of the current query that was parsed
-
getParent
public DeclarationResolver getParent()
Returns the parent of thisResolver
.
-
getQuery
public IQuery getQuery()
Returns the external form representing the JPQL query.
-
getResolver
public Resolver getResolver(String variableName)
Retrieves theResolver
mapped with the given identification variable. If the identification is not defined in the declaration traversed by this resolver, than the search will traverse the parent hierarchy.
-
getResultVariables
public Set<String> getResultVariables()
Returns the variables that got defined in the select expression. This only applies to JPQL queries built for JPA 2.0 or later.- Returns:
- The variables identifying the select expressions, if any was defined or an empty set if none were defined
-
getResultVariablesMap
public Map<IdentificationVariable,String> getResultVariablesMap()
Returns the map of result variables that got used to define a select expression. This only applies to JPQL queries built for JPA 2.0.- Returns:
- The variables identifying the select expressions, if any was defined or an empty map if none were defined
-
hasJoins
public boolean hasJoins()
Determines whether the JPQL expression has JOIN expressions.- Returns:
true
if the query or subquery being traversed contains JOIN expressions;false
otherwise
-
isCollectionIdentificationVariable
public boolean isCollectionIdentificationVariable(String variableName)
Determines whether the given identification variable is defining a JOIN expression or in aIN
expressions for a collection-valued field. If the search didn't find the identification in this resolver, then it will traverse the parent hierarchy.- Parameters:
variableName
- The identification variable to check for what it maps- Returns:
true
if the given identification variable maps a collection-valued field defined in aJOIN
orIN
expression;false
otherwise
-
isRangeIdentificationVariable
public boolean isRangeIdentificationVariable(String variableName)
Determines whether the given variable name is an identification variable name mapping an entity. The search traverses the parent resolver if it is not found in this resolver, which represents the current JPQL query.- Parameters:
variableName
- The name of the variable to verify if it's defined in a range variable declaration in the current query or any parent query- Returns:
true
if the variable name is mapping an abstract schema name;false
if it's defined in a collection member declaration
-
isResultVariable
public boolean isResultVariable(String variable)
Determines if the given variable is a result variable.- Parameters:
variable
- The variable to check if it's a result variable- Returns:
true
if the given variable is defined as a result variable;false
otherwise
-
populate
public void populate(Expression expression)
Visits the current query (which is either the top-level query or a subquery) and gathers the information from the declaration clause.- Parameters:
expression
- TheExpression
to visit in order to retrieve the information contained in the given query's declaration
-
-