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
BNF: 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 . |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this
AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this
AbstractExpression to the given list. |
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.
|
protected boolean |
isParsingComplete(WordParser wordParser,
java.lang.String word,
Expression expression)
Determines whether the parsing is complete based on what is left in the given text.
|
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given
WordParser . |
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.
|
protected boolean |
shouldParseWithFactoryFirst()
Determines whether the parsing of the query should be performed using the
factories first or it should automatically fallback to the fallback factory. |
protected void |
toParsedText(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this
Expression , including its children,
if it has any. |
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldSkipLiteral, 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.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression
to the given collection.addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression
to the given list.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this AbstractExpression
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 parsedprotected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
wordParser
- The text to parse based on the current position of the cursorword
- The word that was retrieved from the given text, which is the first word in the textexpression
- The Expression
that has already been parsedtrue
if the text no longer can't be parsed by the current expression;
false
if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser
.parse
in class AbstractExpression
wordParser
- The text to parse based on the current position of the cursortolerant
- Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queriespublic 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" objectprotected boolean shouldParseWithFactoryFirst()
factories
first or it should automatically fallback to the fallback factory.shouldParseWithFactoryFirst
in class AbstractExpression
true
is returned by default so the factories are used before falling backprotected void toParsedText(java.lang.StringBuilder writer, boolean actual)
Expression
, including its children,
if it has any.toParsedText
in class AbstractExpression
writer
- The buffer used to append this Expression
's string representationactual
- Determines whether the string representation should represent what was parsed,
i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the
JPQL identifiers