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
ThisResolveris 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 anUDPATEclause, it will be retrieved from the unique identification range variable declaration.- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.3
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classDeclarationResolver.DeclarationVisitorprotected static classDeclarationResolver.QualifyRangeDeclarationVisitorprotected classDeclarationResolver.RootObjectExpressionVisitorThis visitor takes care to support a subquery defined as a "root" object.
-
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 protected voidaddDeclaration(Declaration declaration)Adds the givenDeclarationat the end of the list.voidaddRangeVariableDeclaration(java.lang.String entityName, java.lang.String variableName)Registers a range variable declaration that will be used when a JPQL fragment is parsed.protected DeclarationResolver.DeclarationVisitorbuildDeclarationVisitor()protected DeclarationResolver.RootObjectExpressionVisitorbuildRootObjectExpressionVisitor()protected ITypebuildType()protected ITypeDeclarationbuildTypeDeclaration()Resolves theITypeDeclarationof the property handled by thisResolver.protected voidcheckParent(Resolver parent)voidconvertUnqualifiedDeclaration(Declaration declaration, java.lang.String outerVariableName)Converts the givenDeclarationfrom being set as a range variable declaration to a path expression declaration.voiddispose()Disposes the internal data.DeclarationgetDeclaration(java.lang.String variableName)Retrieves theDeclarationfor which the given variable name is used to navigate to the "root" object.java.util.List<Declaration>getDeclarations()Returns the ordered list ofDeclarations.protected DeclarationResolver.DeclarationVisitorgetDeclarationVisitor()DeclarationResolvergetParent()Returns the parent of thisResolver.IQuerygetQuery()Returns the external form representing the JPQL query.protected JPQLQueryContextgetQueryContext()Returns theJPQLQueryContextthat is used by this visitor.ResolvergetResolver(java.lang.String variableName)Retrieves theResolvermapped with the given identification variable.protected ResolvergetResolverImp(java.lang.String variableName)Retrieves theResolvermapped with the given identification variable.java.util.Set<java.lang.String>getResultVariables()Returns the variables that got defined in the select expression.java.util.Map<IdentificationVariable,java.lang.String>getResultVariablesMap()Returns the map of result variables that got used to define a select expression.protected DeclarationResolver.RootObjectExpressionVisitorgetRootObjectExpressionVisitor()booleanhasJoins()Determines whether the JPQL expression has JOIN expressions.protected voidinitialize(JPQLQueryContext queryContext)Initializes thisDeclarationResolver.booleanisCollectionIdentificationVariable(java.lang.String variableName)Determines whether the given identification variable is defining a JOIN expression or in aINexpressions for a collection-valued field.protected booleanisCollectionIdentificationVariableImp(java.lang.String variableName)Determines whether the given identification variable is defining a JOIN expression or in aINexpressions for a collection-valued field.booleanisRangeIdentificationVariable(java.lang.String variableName)Determines whether the given variable name is an identification variable name mapping an entity.protected booleanisRangeIdentificationVariableImp(java.lang.String variableName)Determines whether the given variable name is an identification variable name mapping an entity.booleanisResultVariable(java.lang.String variable)Determines if the given variable is a result variable.voidpopulate(Expression expression)Visits the current query (which is either the top-level query or a subquery) and gathers the information from the declaration clause.protected DeclarationResolver.QualifyRangeDeclarationVisitorqualifyRangeDeclarationVisitor()protected ResolverresolveRootObject(Expression expression)Resolves the "root" object represented by the givenExpression.protected java.lang.StringvisitDeclaration(Expression expression, Expression identificationVariable)-
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
-
addDeclaration
protected final void addDeclaration(Declaration declaration)
Adds the givenDeclarationat the end of the list.- Parameters:
declaration- TheDeclarationrepresenting a single variable declaration
-
addRangeVariableDeclaration
public void addRangeVariableDeclaration(java.lang.String entityName, java.lang.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
-
buildDeclarationVisitor
protected DeclarationResolver.DeclarationVisitor buildDeclarationVisitor()
-
buildRootObjectExpressionVisitor
protected DeclarationResolver.RootObjectExpressionVisitor buildRootObjectExpressionVisitor()
-
buildType
protected IType buildType()
-
buildTypeDeclaration
protected ITypeDeclaration buildTypeDeclaration()
Resolves theITypeDeclarationof the property handled by thisResolver.- Specified by:
buildTypeDeclarationin classResolver- Returns:
- Either the
ITypeDeclarationthat was resolved by thisResolveror theITypeDeclarationforIType.UNRESOLVABLE_TYPEif it could not be resolved
-
checkParent
protected void checkParent(Resolver parent)
- Overrides:
checkParentin classResolver
-
convertUnqualifiedDeclaration
public void convertUnqualifiedDeclaration(Declaration declaration, java.lang.String outerVariableName)
Converts the givenDeclarationfrom 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- TheDeclarationthat 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(java.lang.String variableName)
Retrieves theDeclarationfor 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
Declarationcontaining the information about the identification variable declaration - Since:
- 2.5
-
getDeclarations
public java.util.List<Declaration> getDeclarations()
Returns the ordered list ofDeclarations.- Returns:
- The
Declarationsof the current query that was parsed
-
getDeclarationVisitor
protected DeclarationResolver.DeclarationVisitor getDeclarationVisitor()
-
getParent
public DeclarationResolver getParent()
Returns the parent of thisResolver.
-
getQuery
public IQuery getQuery()
Returns the external form representing the JPQL query.
-
getQueryContext
protected JPQLQueryContext getQueryContext()
Returns theJPQLQueryContextthat is used by this visitor.- Returns:
- The
JPQLQueryContextholding onto the JPQL query and the cached information
-
getResolver
public Resolver getResolver(java.lang.String variableName)
Retrieves theResolvermapped 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.
-
getResolverImp
protected Resolver getResolverImp(java.lang.String variableName)
Retrieves theResolvermapped with the given identification variable. The search does not traverse the parent hierarchy.
-
getResultVariables
public java.util.Set<java.lang.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 java.util.Map<IdentificationVariable,java.lang.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
-
getRootObjectExpressionVisitor
protected DeclarationResolver.RootObjectExpressionVisitor getRootObjectExpressionVisitor()
-
hasJoins
public boolean hasJoins()
Determines whether the JPQL expression has JOIN expressions.- Returns:
trueif the query or subquery being traversed contains JOIN expressions;falseotherwise
-
initialize
protected void initialize(JPQLQueryContext queryContext)
Initializes thisDeclarationResolver.- Parameters:
queryContext- The context used to query information about the query
-
isCollectionIdentificationVariable
public boolean isCollectionIdentificationVariable(java.lang.String variableName)
Determines whether the given identification variable is defining a JOIN expression or in aINexpressions 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:
trueif the given identification variable maps a collection-valued field defined in aJOINorINexpression;falseotherwise
-
isCollectionIdentificationVariableImp
protected boolean isCollectionIdentificationVariableImp(java.lang.String variableName)
Determines whether the given identification variable is defining a JOIN expression or in aINexpressions for a collection-valued field. The search does not traverse the parent hierarchy.- Parameters:
variableName- The identification variable to check for what it maps- Returns:
trueif the given identification variable maps a collection-valued field defined in aJOINorINexpression;falseotherwise
-
isRangeIdentificationVariable
public boolean isRangeIdentificationVariable(java.lang.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:
trueif the variable name is mapping an abstract schema name;falseif it's defined in a collection member declaration
-
isRangeIdentificationVariableImp
protected boolean isRangeIdentificationVariableImp(java.lang.String variableName)
Determines whether the given variable name is an identification variable name mapping an entity. The search only searches 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:
trueif the variable name is mapping an abstract schema name;falseif it's defined in a collection member declaration
-
isResultVariable
public boolean isResultVariable(java.lang.String variable)
Determines if the given variable is a result variable.- Parameters:
variable- The variable to check if it's a result variable- Returns:
trueif the given variable is defined as a result variable;falseotherwise
-
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- TheExpressionto visit in order to retrieve the information contained in the given query's declaration
-
qualifyRangeDeclarationVisitor
protected DeclarationResolver.QualifyRangeDeclarationVisitor qualifyRangeDeclarationVisitor()
-
resolveRootObject
protected Resolver resolveRootObject(Expression expression)
Resolves the "root" object represented by the givenExpression. This will also handle using a subquery in theFROMclause. This is only supported by EclipseLink.- Parameters:
expression- TheExpressionto visit, which represents the "root" object of a declaration- Returns:
- The
Resolverfor the givenExpression
-
visitDeclaration
protected java.lang.String visitDeclaration(Expression expression, Expression identificationVariable)
-
-