Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.parser

public final Class TableVariableDeclaration

extends AbstractExpression
Class Inheritance
Imports
java.util.Collection, .List, org.eclipse.persistence.jpa.jpql.ExpressionTools, .WordParser
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
Author
Pascal Filion
Since
2.4
Version
2.5

Field Summary

Modifier and TypeField and Description
private String
asIdentifier

The actual AS identifier found in the string representation of the JPQL query.

private boolean
hasSpaceAfterAs

Determines whether a whitespace was parsed after AS.

private boolean
hasSpaceAfterTableExpression

Determines whether a whitespace was parsed after the "root" object.

private AbstractExpression
identificationVariable

The Expression representing the identification variable.

private TableExpression
tableExpression

The Expression representing the database table.

Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
COMMADOTDOUBLE_QUOTELEFT_CURLY_BRACKETLEFT_PARENTHESISNOT_DEFINEDRIGHT_CURLY_BRACKETRIGHT_PARENTHESISSINGLE_QUOTESPACEUNDERSCORE

Constructor Summary

AccessConstructor and Description
public
TableVariableDeclaration(AbstractExpression
The parent of this expression
parent)

Creates a new TableVariableDeclaration.

Method Summary

Modifier and TypeMethod and Description
public void
accept(ExpressionVisitor
The ExpressionVisitor to visit this object
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.
public void
acceptChildren(ExpressionVisitor
The visitor to visit the children of this object.
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression.
protected void
addChildrenTo(Collection<Expression>
The collection used to store the children
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.
protected void
addOrderedChildrenTo(List<Expression>
The list used to store the string representation of this AbstractExpression
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.
public JPQLQueryBNF
findQueryBNF(Expression
The Expression that is a descendant of this one
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
public String

Returns:

The AS identifier that was actually parsed, or an empty string if it was not parsed
getActualAsIdentifier()

Returns the actual AS found in the string representation of the JPQL query, which has the actual case that was used.

public Expression

Returns:

The expression that was parsed representing the identification variable
getIdentificationVariable()

Returns the Expression that represents the identification variable.

public JPQLQueryBNF
getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.
public TableExpression

Returns:

The expression that was parsed specifying the database table
getTableExpression()

Returns the TableExpression that specify the database table.

public boolean

Returns:

true if the identifier AS was parsed; false otherwise
hasAs()

Determines whether the identifier AS was parsed.

public boolean

Returns:

true if the identification variable was parsed; false otherwise
hasIdentificationVariable()

Determines whether the identification variable was parsed.

public boolean

Returns:

true if there was a whitespace after AS; false otherwise
hasSpaceAfterAs()

Determines whether a whitespace was parsed after AS.

public boolean

Returns:

true if there was a whitespace after the table expression; false otherwise
hasSpaceAfterTableExpression()

Determines whether a whitespace was parsed after the table expression.

protected boolean
isParsingComplete(WordParser
The text to parse based on the current position of the cursor
wordParser, String
The word that was retrieved from the given text, which is the first word in the text
word, Expression
The Expression that has already been parsed
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Determines whether the parsing is complete based on what is left in the given text.
protected void
parse(WordParser
The text to parse based on the current position of the cursor
wordParser, boolean
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.
protected void
toParsedText(StringBuilder
The buffer used to append this Expression's string representation
writer, boolean
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
actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
acceptUnknownVisitoracceptUnknownVisitorbuildExpressionFromFallingBackbuildNullExpressionbuildStringExpressionbuildStringExpressionbuildUnknownExpressioncalculatePositionchildrenfindFallBackExpressionFactorygetExpressionFactorygetExpressionRegistrygetGrammargetIdentifierVersiongetJPAVersiongetLengthgetOffsetgetParentgetQueryBNFgetRootgetTexthandleAggregatehandleCollectionisAncestorisIdentifierisNullisTolerantisUnknownisVirtualorderedChildrenparseparseUsingExpressionFactorypopulatePositionrebuildActualTextrebuildParsedTextsetParentsetTextshouldParseWithFactoryFirstshouldSkipLiteraltoActualTexttoParsedTexttoString

Field Detail

asIdentifierback to summary
private String asIdentifier

The actual AS identifier found in the string representation of the JPQL query.

hasSpaceAfterAsback to summary
private boolean hasSpaceAfterAs

Determines whether a whitespace was parsed after AS.

hasSpaceAfterTableExpressionback to summary
private boolean hasSpaceAfterTableExpression

Determines whether a whitespace was parsed after the "root" object.

identificationVariableback to summary
private AbstractExpression identificationVariable

The Expression representing the identification variable.

tableExpressionback to summary
private TableExpression tableExpression

The Expression representing the database table.

Constructor Detail

TableVariableDeclarationback to summary
public TableVariableDeclaration(AbstractExpression parent)

Creates a new TableVariableDeclaration.

Parameters
parent:AbstractExpression

The parent of this expression

Method Detail

acceptback to summary
public void accept(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.

Parameters
visitor:ExpressionVisitor

The ExpressionVisitor to visit this object

Annotations
@Override
acceptChildrenback to summary
public void acceptChildren(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

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 children() is called.

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

Parameters
visitor:ExpressionVisitor

The visitor to visit the children of this object.

Annotations
@Override
addChildrenToback to summary
protected void addChildrenTo(Collection<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.

Parameters
children:Collection<Expression>

The collection used to store the children

Annotations
@Override
addOrderedChildrenToback to summary
protected void addOrderedChildrenTo(List<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.

Parameters
children:List<Expression>

The list used to store the string representation of this AbstractExpression

Annotations
@Override
findQueryBNFback to summary
public JPQLQueryBNF findQueryBNF(Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Parameters
expression:Expression

The Expression that is a descendant of this one

Returns:JPQLQueryBNF

The JPQLQueryBNF that was used to parse the given expression

Annotations
@Override
getActualAsIdentifierback to summary
public String getActualAsIdentifier()

Returns the actual AS found in the string representation of the JPQL query, which has the actual case that was used.

Returns:String

The AS identifier that was actually parsed, or an empty string if it was not parsed

getIdentificationVariableback to summary
public Expression getIdentificationVariable()

Returns the Expression that represents the identification variable.

Returns:Expression

The expression that was parsed representing the identification variable

getQueryBNFback to summary
public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations
@Override
getTableExpressionback to summary
public TableExpression getTableExpression()

Returns the TableExpression that specify the database table.

Returns:TableExpression

The expression that was parsed specifying the database table

hasAsback to summary
public boolean hasAs()

Determines whether the identifier AS was parsed.

Returns:boolean

true if the identifier AS was parsed; false otherwise

hasIdentificationVariableback to summary
public boolean hasIdentificationVariable()

Determines whether the identification variable was parsed.

Returns:boolean

true if the identification variable was parsed; false otherwise

hasSpaceAfterAsback to summary
public boolean hasSpaceAfterAs()

Determines whether a whitespace was parsed after AS.

Returns:boolean

true if there was a whitespace after AS; false otherwise

hasSpaceAfterTableExpressionback to summary
public boolean hasSpaceAfterTableExpression()

Determines whether a whitespace was parsed after the table expression.

Returns:boolean

true if there was a whitespace after the table expression; false otherwise

isParsingCompleteback to summary
protected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Determines whether the parsing is complete based on what is left in the given text. The text is never empty.

Parameters
wordParser:WordParser

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

word:String

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

expression:Expression

The Expression that has already been parsed

Returns:boolean

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

Annotations
@Override
parseback to summary
protected void parse(WordParser wordParser, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

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

Parameters
wordParser:WordParser

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

tolerant:boolean

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

Annotations
@Override
toParsedTextback to summary
protected void toParsedText(StringBuilder writer, boolean actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.

Parameters
writer:StringBuilder

The buffer used to append this Expression's string representation

actual:boolean

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

Annotations
@Override