public interface JPQLQueryDeclaration
JPQLQueryDeclaration
represents either an identification variable declaration or a
collection member declaration. For a subquery, the declaration can be a derived path expression.
Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Modifier and Type | Interface and Description |
---|---|
static class |
JPQLQueryDeclaration.Type
This enum type defines the various types of declarations supported by both the JPA functional
specification and EclipseLink.
|
Modifier and Type | Method and Description |
---|---|
Expression |
getBaseExpression()
Returns the range variable declaration if this is a range declaration otherwise the
collection-valued path expression when this is a collection member declaration.
|
Expression |
getDeclarationExpression()
Returns the declaration expression, which is either an {@link org.eclipse.persistence.jpa.jpql.
|
java.util.List<Join> |
getJoins()
Returns the
JOIN expressions defined with this declaration, if supported. |
JPQLQueryDeclaration.Type |
getType()
Determines the type this declaration represents.
|
java.lang.String |
getVariableName()
Returns the identification variable name that is defining either the abstract schema name
or the collection-valued path expression
|
boolean |
hasJoins()
Determines whether the declaration contains JOIN expressions.
|
Expression getBaseExpression()
Expression getDeclarationExpression()
parser.IdentificationVariableDeclaration IdentificationVariableDeclaration
or a CollectionMemberDeclaration
when part of a FROM clause, otherwise it's either the jpa.jpql.parser.DeleteClause DeleteClause
or the parser.UpdateClause UpdateClause
.java.util.List<Join> getJoins()
JOIN
expressions defined with this declaration, if supported.
The list contains the JOIN
expressions in ordered they were declared.JPQLQueryDeclaration.Type getType()
java.lang.String getVariableName()
boolean hasJoins()
true
only when #isRange()
returns true
. A collection
member declaration does not have JOIN expressions.true
if at least one JOIN expression was parsed;
otherwise false