Class TableVariableDeclaration
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.TableVariableDeclaration
-
- All Implemented Interfaces:
Expression
public final class TableVariableDeclaration extends AbstractExpression
Defines a table expression. This allow a non-mapped table to be used in a query. This is not part of the JPA functional specification but is EclipseLink specific support.BNF:table_variable_declaration ::= table_expression [AS] identification_variable
- Since:
- 2.4
- Version:
- 2.5
- Author:
- Pascal Filion
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.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.jpql.parser.Expression
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 Summary
Constructors Constructor Description TableVariableDeclaration(AbstractExpression parent)
Creates a newTableVariableDeclaration
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.void
acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
.JPQLQueryBNF
findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.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 theExpression
that represents the identification variable.JPQLQueryBNF
getQueryBNF()
Returns the BNF of thisExpression
.TableExpression
getTableExpression()
Returns theTableExpression
that specify the database table.boolean
hasAs()
Determines whether the identifier AS was parsed.boolean
hasIdentificationVariable()
Determines whether the identification variable was parsed.boolean
hasSpaceAfterAs()
Determines whether a whitespace was parsed after AS.boolean
hasSpaceAfterTableExpression()
Determines whether a whitespace was parsed after the table expression.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
TableVariableDeclaration
public TableVariableDeclaration(AbstractExpression parent)
Creates a newTableVariableDeclaration
.- Parameters:
parent
- The parent of this expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.- Parameters:
visitor
- TheExpressionVisitor
to visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()
is called.This does not traverse the
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.- Specified by:
findQueryBNF
in interfaceExpression
- Overrides:
findQueryBNF
in classAbstractExpression
- Parameters:
expression
- TheExpression
that is a descendant of this one- Returns:
- The
JPQLQueryBNF
that was used to parse the given expression
-
getActualAsIdentifier
public 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.- Returns:
- The AS identifier that was actually parsed, or an empty string if it was not parsed
-
getIdentificationVariable
public Expression getIdentificationVariable()
Returns theExpression
that represents the identification variable.- Returns:
- The expression that was parsed representing the identification variable
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression
.- Returns:
- The
JPQLQueryBNF
, which represents the grammar of thisExpression
-
getTableExpression
public TableExpression getTableExpression()
Returns theTableExpression
that specify the database table.- Returns:
- The expression that was parsed specifying the database table
-
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
-
hasSpaceAfterAs
public boolean hasSpaceAfterAs()
Determines whether a whitespace was parsed after AS.- Returns:
true
if there was a whitespace after AS;false
otherwise
-
hasSpaceAfterTableExpression
public boolean hasSpaceAfterTableExpression()
Determines whether a whitespace was parsed after the table expression.- Returns:
true
if there was a whitespace after the table expression;false
otherwise
-
-