org.eclipse.persistence.jpa.internal.jpql.parser

Class RangeVariableDeclaration

java.lang.Object

org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression

org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

org.eclipse.persistence.jpa.internal.jpql.parser.RangeVariableDeclaration

All Implemented Interfaces:

Expression

public final class RangeVariableDeclaration
extends AbstractExpression

Range variable declarations allow the developer to designate a "root" for objects which may not be reachable by navigation. In order to select values by comparing more than one instance of an entity abstract schema type, more than one identification variable ranging over the abstract schema type is needed in the FROM clause.

BNF: range_variable_declaration ::= abstract_schema_name [AS] identification_variable

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE

Fields inherited from interface org.eclipse.persistence.jpa.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

Methods

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.
Expression	getAbstractSchemaName() Returns the Expression that represents the abstract schema name.
Expression	getIdentificationVariable() Returns the Expression that represents the identification variable.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
boolean	hasAbstractSchemaName() Determines whether the abstract schema name was parsed.
boolean	hasAs() Determines whether the identifier AS was parsed.
boolean	hasIdentificationVariable() Determines whether the identification variable was parsed.
boolean	hasSpaceAfterAbstractSchemaName() Determines whether a whitespace was parsed after the abstract schema name.
boolean	hasSpaceAfterAs() Determines whether a whitespace was parsed after AS.
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, java.lang.String path) Sets a virtual identification variable because the abstract schema name was parsed without one.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

children, findQueryBNF, getChildren, getParent, getRoot, identifierRole, identifiers, identifierVersion, isAncestor, isIdentifier, isVirtual, orderedChildren, queryBNF, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The visitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() or Expression.getChildren() is called.

This does not traverse the Expression sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters:

visitor - The visitor to visit the children of this object.

getAbstractSchemaName

public Expression getAbstractSchemaName()

Returns the Expression that represents the abstract schema name.

Returns:

The expression that was parsed representing the abstract schema name

getIdentificationVariable

public Expression getIdentificationVariable()

Returns the Expression that represents the identification variable.

Returns:

The expression that was parsed representing the identification variable

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

hasAbstractSchemaName

public boolean hasAbstractSchemaName()

Determines whether the abstract schema name was parsed.

Returns:

true if the abstract schema name was parsed; false otherwise

hasAs

public boolean hasAs()

Determines whether the identifier AS was parsed.

Returns:

true if the identifier AS was parsed; false otherwise

hasIdentificationVariable

public boolean hasIdentificationVariable()

Determines whether the identification variable was parsed.

Returns:

true if the identification variable was parsed; false otherwise

hasSpaceAfterAbstractSchemaName

public boolean hasSpaceAfterAbstractSchemaName()

Determines whether a whitespace was parsed after the abstract schema name.

Returns:

true if there was a whitespace after the abstract schema name; false otherwise

hasSpaceAfterAs

public boolean hasSpaceAfterAs()

Determines whether a whitespace was parsed after AS.

Returns:

true if there was a whitespace after AS; false otherwise

hasVirtualIdentificationVariable

public boolean hasVirtualIdentificationVariable()

Determines whether this identification variable is virtual, meaning it's not part of the query but is required for proper navigability.

Returns:

true if this identification variable was virtually created to fully qualify path expression; false if it was parsed

setVirtualIdentificationVariable

public void setVirtualIdentificationVariable(java.lang.String variableName,
                                    java.lang.String path)

Sets a virtual identification variable because the abstract schema name was parsed without one. This is valid in an UPDATE and DELETE queries.

Parameters:

variableName - The identification variable that was generated to identify the abstract schema name

path - The path that was parsed as an abstract schema name