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

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.IdentificationVariableDeclaration

All Implemented Interfaces:

Expression

public final class IdentificationVariableDeclaration

extends AbstractExpression

An identification variable is a valid identifier declared in the FROM clause of a query. All identification variables must be declared in the FROM clause. Identification variables cannot be declared in other clauses. An identification variable must not be a reserved identifier or have the same name as any entity in the same persistence unit: Identification variables are case insensitive. An identification variable evaluates to a value of the type of the expression used in declaring the variable.

BNF: identification_variable_declaration ::= range_variable_declaration { join | fetch_join }*

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

private boolean	hasSpace Determines whether there is a space after the range variable declaration.
private AbstractExpression	joins The unique join (fetch join) or list of join (fetch join) expression or a null expression if none was declared.
private boolean	parsingJoinExpression Flag used to determine how to check if the parsing is complete.
private AbstractExpression	rangeVariableDeclaration The variable declaration, which is the abstract schema name and the variable.

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

Constructor Summary

IdentificationVariableDeclaration(AbstractExpression parent)
Creates a new IdentificationVariableDeclaration.

Method Summary

void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
(package private) void	addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection.
(package private) void	addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this Expression.
CollectionExpression	buildCollectionExpression() Creates a new CollectionExpression that will wrap the single join expression.
Expression	getJoins() Returns the unique join (fetch join) or the list of joins (fetch joins) expression.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
Expression	getRangeVariableDeclaration() Returns the variable declaration, which is the abstract schema name and the identification variable.
boolean	hasJoins() Determines whether this declaration has any join expressions.
boolean	hasRangeVariableDeclaration() Determines whether the range variable declaration was parsed.
boolean	hasSpace() Determines whether there is a space after the range variable declaration.
(package private) 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.
(package private) void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
(package private) void	setRangeVariableDeclaration(java.lang.String abstractSchemaName, java.lang.String identificationVariable) Manually sets the range variable declaration.
(package private) boolean	shouldParseWithFactoryFirst() TODO
(package private) void	toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression.

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

buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, shouldSkipLiteral, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

hasSpace

private boolean hasSpace

Determines whether there is a space after the range variable declaration.

joins

private AbstractExpression joins

The unique join (fetch join) or list of join (fetch join) expression or a null expression if none was declared.

parsingJoinExpression

private boolean parsingJoinExpression

Flag used to determine how to check if the parsing is complete.

rangeVariableDeclaration

private AbstractExpression rangeVariableDeclaration

The variable declaration, which is the abstract schema name and the variable.

Constructor Detail

IdentificationVariableDeclaration

IdentificationVariableDeclaration(AbstractExpression parent)

Creates a new IdentificationVariableDeclaration.

Parameters:

parent - The parent of this expression

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.

addChildrenTo

void addChildrenTo(java.util.Collection<Expression> children)

Adds the children of this Expression to the given collection.

Overrides:

addChildrenTo in class AbstractExpression

Parameters:

children - The collection used to store the children

addOrderedChildrenTo

void addOrderedChildrenTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing this Expression.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this Expression

buildCollectionExpression

public CollectionExpression buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single join expression.

Returns:

The single join expression represented by a temporary collection

getJoins

public Expression getJoins()

Returns the unique join (fetch join) or the list of joins (fetch joins) expression.

Returns:

The JOIN expression(s) or a null expression if none was declared

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

getRangeVariableDeclaration

public Expression getRangeVariableDeclaration()

Returns the variable declaration, which is the abstract schema name and the identification variable.

Returns:

The Expression representing the range variable declaration

hasJoins

public boolean hasJoins()

Determines whether this declaration has any join expressions.

Returns:

true if at least one join expression was specified; false otherwise

hasRangeVariableDeclaration

public boolean hasRangeVariableDeclaration()

Determines whether the range variable declaration was parsed.

Returns:

true if the range variable declaration was parsed; false otherwise

hasSpace

public boolean hasSpace()

Determines whether there is a space after the range variable declaration.

Returns:

true if the range variable declaration is followed by a space, false otherwise

isParsingComplete

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. The text is never empty.

Overrides:

isParsingComplete in class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

word - The word that was retrieved from the given text, which is the first word in the text

expression - The Expression that has already been parsed

Returns:

true if the text no longer can't be parsed by the current expression; false if more can be parsed

parse

void parse(WordParser wordParser,
           boolean tolerant)

Parses the query by starting at the current position, which is part of the given WordParser.

Specified by:

parse in class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

setRangeVariableDeclaration

void setRangeVariableDeclaration(java.lang.String abstractSchemaName,
                                 java.lang.String identificationVariable)

Manually sets the range variable declaration.

Parameters:

abstractSchemaName - The abstract schema name to be mapped to the given variable

identificationVariable - The identification variable mapping the given schema name

shouldParseWithFactoryFirst

boolean shouldParseWithFactoryFirst()

TODO

Overrides:

shouldParseWithFactoryFirst in class AbstractExpression

Returns:

toParsedText

void toParsedText(java.lang.StringBuilder writer,
                  boolean includeVirtual)

Generates a string representation of this Expression.

Specified by:

toParsedText in class AbstractExpression

Parameters:

writer - The buffer used to append this Expression's string representation

includeVirtual - Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist