public final class RangeVariableDeclaration extends AbstractExpression
JPA:
range_variable_declaration ::= abstract_schema_name [AS] identification_variable
EclipseLink 2.4:
range_variable_declaration ::= { root_object } [AS] identification_variable
root_object ::= abstract_schema_name | (subquery)
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE
ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
Constructor and Description |
---|
RangeVariableDeclaration(AbstractExpression parent)
Creates a new
RangeVariableDeclaration . |
RangeVariableDeclaration(java.lang.String entityName,
java.lang.String variableName)
Creates a new
RangeVariableDeclaration , which is used as a virtual declaration. |
Modifier and Type | Method and Description |
---|---|
void |
accept(ExpressionVisitor visitor)
Visits this
Expression by the given visitor . |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this
Expression . |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression . |
java.lang.String |
getActualAsIdentifier()
Returns the actual AS found in the string representation of the JPQL query, which has
the actual case that was used.
|
Expression |
getIdentificationVariable()
Returns the
Expression that represents the identification variable. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this
Expression . |
Expression |
getRootObject()
Returns the
Expression that represents the "root" object. |
boolean |
hasAs()
Determines whether the identifier AS was parsed.
|
boolean |
hasIdentificationVariable()
Determines whether the identification variable was parsed.
|
boolean |
hasRootObject()
Determines whether the "root" object was parsed.
|
boolean |
hasSpaceAfterAs()
Determines whether a whitespace was parsed after AS.
|
boolean |
hasSpaceAfterRootObject()
Determines whether a whitespace was parsed after the "root" object.
|
boolean |
hasVirtualIdentificationVariable()
Determines whether this identification variable is virtual, meaning it's not part of the
query but is required for proper navigability.
|
void |
setVirtualIdentificationVariable(java.lang.String variableName)
Sets a virtual identification variable because the "root" object was parsed without one.
|
void |
setVirtualIdentificationVariable(java.lang.String variableName,
java.lang.String path)
Sets a virtual identification variable to qualify the "root" object.
|
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString
public RangeVariableDeclaration(AbstractExpression parent)
RangeVariableDeclaration
.parent
- The parent of this expressionpublic RangeVariableDeclaration(java.lang.String entityName, java.lang.String variableName)
RangeVariableDeclaration
, which is used as a virtual declaration.entityName
- The name of the entity to be accessible with the given variable namevariableName
- The identification variable used to navigate to the entitypublic void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The ExpressionVisitor
to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
Expression
. This method can be used to optimize traversing
the children since a new list is not created every time Expression.children()
is called.
This does not traverse the Expression
sub-hierarchy, use a subclass of
AbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.
visitor
- The visitor
to visit the children of this object.public JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF
that represents the fragment of this Expression
that was used when parsing the given Expression
.findQueryBNF
in interface Expression
findQueryBNF
in class AbstractExpression
expression
- The Expression
that is a descendant of this oneJPQLQueryBNF
that was used to parse the given expressionpublic java.lang.String getActualAsIdentifier()
public Expression getIdentificationVariable()
Expression
that represents the identification variable.public JPQLQueryBNF getQueryBNF()
Expression
.JPQLQueryBNF
, which represents the grammar of this Expression
public Expression getRootObject()
Expression
that represents the "root" object.public boolean hasAs()
true
if the identifier AS was parsed; false
otherwisepublic boolean hasIdentificationVariable()
true
if the identification variable was parsed; false
otherwisepublic boolean hasRootObject()
true
if the "root" object was parsed; false
otherwisepublic boolean hasSpaceAfterAs()
true
if there was a whitespace after AS; false
otherwisepublic boolean hasSpaceAfterRootObject()
true
if there was a whitespace after "root" object;
false
otherwisepublic boolean hasVirtualIdentificationVariable()
true
if this identification variable was virtually created to fully
qualify path expression; false
if it was parsedpublic void setVirtualIdentificationVariable(java.lang.String variableName)
UPDATE DateTime SET date = CURRENT_DATE
is equivalent to
UPDATE DateTime d SET d.date = CURRENT_DATE
variableName
- A virtual identification variable that will identify the "root" objectpublic void setVirtualIdentificationVariable(java.lang.String variableName, java.lang.String path)
UPDATE Employee SET firstName = 'MODIFIED'
WHERE (SELECT COUNT(m) FROM managedEmployees m) > 0
'managedEmployees' is a derived path and will become qualified with the given virtual identification variable.
variableName
- The identification variable that was generated to qualify the "root" objectpath
- The path that was parsed as a "root" objectEclipseLink 2.6.3, "build v20160428-59c81c5" API Reference