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

public final Class ResultVariable

extends AbstractExpression
Class Inheritance
Imports
java.util.Collection, .List, org.eclipse.persistence.jpa.jpql.ExpressionTools, .WordParser
A result variable may be used to name a select item in the query result.
BNF: select_item ::= select_expression [[AS] result_variable]
Author
Pascal Filion
Since
2.3
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 the identifier AS.

private AbstractExpression
resultVariable

The Expression used

private AbstractExpression
selectExpression

The Expression representing the select expression.

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
ResultVariable(AbstractExpression
The parent of this expression
parent, AbstractExpression
The expression that represents the select expression, which will have a variable assigned to it
selectExpression)

Creates a new ResultVariable.

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 JPQLQueryBNF
getQueryBNF()

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

Returns the BNF of this Expression.
public Expression

Returns:

The expression for the result variable
getResultVariable()

Returns the Expression representing the result variable.

public Expression

Returns:

The expression for the select expression
getSelectExpression()

Returns the Expression representing the select expression.

public boolean

Returns:

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

Determines whether the identifier AS was parsed or not.

public boolean

Returns:

true if the result variable was parsed; false otherwise
hasResultVariable()

Determines whether the result variable was parsed.

public boolean

Returns:

true if the select expression was parsed; false if the result variable was parsed without one
hasSelectExpression()

Determines whether a select expression was defined for this result variable.

public boolean

Returns:

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

Determines whether a whitespace was parsed after the identifier AS.

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:
acceptUnknownVisitoracceptUnknownVisitorbuildExpressionFromFallingBackbuildNullExpressionbuildStringExpressionbuildStringExpressionbuildUnknownExpressioncalculatePositionchildrenfindFallBackExpressionFactorygetExpressionFactorygetExpressionRegistrygetGrammargetIdentifierVersiongetJPAVersiongetLengthgetOffsetgetParentgetQueryBNFgetRootgetTexthandleAggregatehandleCollectionisAncestorisIdentifierisNullisParsingCompleteisTolerantisUnknownisVirtualorderedChildrenparseparseUsingExpressionFactorypopulatePositionrebuildActualTextrebuildParsedTextsetParentsetTextshouldParseWithFactoryFirstshouldSkipLiteraltoActualTexttoParsedTexttoString

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 the identifier AS.

resultVariableback to summary
private AbstractExpression resultVariable

The Expression used

selectExpressionback to summary
private AbstractExpression selectExpression

The Expression representing the select expression.

Constructor Detail

ResultVariableback to summary
public ResultVariable(AbstractExpression parent, AbstractExpression selectExpression)

Creates a new ResultVariable.

Parameters
parent:AbstractExpression

The parent of this expression

selectExpression:AbstractExpression

The expression that represents the select expression, which will have a variable assigned to it

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

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
getResultVariableback to summary
public Expression getResultVariable()

Returns the Expression representing the result variable.

Returns:Expression

The expression for the result variable

getSelectExpressionback to summary
public Expression getSelectExpression()

Returns the Expression representing the select expression.

Returns:Expression

The expression for the select expression

hasAsback to summary
public boolean hasAs()

Determines whether the identifier AS was parsed or not.

Returns:boolean

true if the identifier AS was parsed; false otherwise

hasResultVariableback to summary
public boolean hasResultVariable()

Determines whether the result variable was parsed.

Returns:boolean

true if the result variable was parsed; false otherwise

hasSelectExpressionback to summary
public boolean hasSelectExpression()

Determines whether a select expression was defined for this result variable.

Returns:boolean

true if the select expression was parsed; false if the result variable was parsed without one

hasSpaceAfterAsback to summary
public boolean hasSpaceAfterAs()

Determines whether a whitespace was parsed after the identifier AS.

Returns:boolean

true if there was a whitespace after AS; false otherwise

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