EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.parser.RangeVariableDeclaration

Modifier and Type	Field 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	hasSpaceAfterRootObject Determines whether a whitespace was parsed after the "root" object.
private AbstractExpression	identificationVariable The `Expression` representing the identification variable.
private AbstractExpression	rootObject The `Expression` representing the "root" object.
private boolean	virtualIdentificationVariable Determines whether the identification variable is virtual, meaning it's not part of the query but is required for proper navigability.

Access	Constructor and Description
public	RangeVariableDeclaration(AbstractExpression The parent of this expression parent) Creates a new `RangeVariableDeclaration`.
public	RangeVariableDeclaration(String The name of the entity to be accessible with the given variable name entityName, String The identification variable used to navigate to the entity variableName) Creates a new `RangeVariableDeclaration`, which is used as a virtual declaration.

Method Summary

Modifier and Type	Method 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 Expression	Returns: The expression that was parsed representing the "root" object getRootObject() Returns the `Expression` that represents the "root" object.
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 the "root" object was parsed; `false` otherwise hasRootObject() Determines whether the "root" object 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 "root" object; `false` otherwise hasSpaceAfterRootObject() Determines whether a whitespace was parsed after the "root" object.
public boolean	Returns: `true` if this identification variable was virtually created to fully qualify path expression; `false` if it was parsed hasVirtualIdentificationVariable() Determines whether this identification variable is virtual, meaning it's not part of the query but is required for proper navigability.
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`.
public void	setVirtualIdentificationVariable(String A virtual identification variable that will identify the "root" object variableName) Sets a virtual identification variable because the "root" object was parsed without one.
public void	setVirtualIdentificationVariable(String The identification variable that was generated to qualify the "root" object variableName, String The path that was parsed as a "root" object path) Sets a virtual identification variable to qualify the "root" object.
protected boolean	shouldParseWithFactoryFirst() Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.shouldParseWithFactoryFirst. Determines whether the parsing of the query should be performed using the `factories` first or it should automatically fallback to the fallback factory.
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.

asIdentifier	back to summary
private String asIdentifier The actual AS identifier found in the string representation of the JPQL query.

hasSpaceAfterAs	back to summary
private boolean hasSpaceAfterAs Determines whether a whitespace was parsed after AS.

hasSpaceAfterRootObject	back to summary
private boolean hasSpaceAfterRootObject Determines whether a whitespace was parsed after the "root" object.

identificationVariable	back to summary
private AbstractExpression identificationVariable The `Expression` representing the identification variable.

rootObject	back to summary
private AbstractExpression rootObject The `Expression` representing the "root" object.

virtualIdentificationVariable	back to summary
private boolean virtualIdentificationVariable Determines whether the identification variable is virtual, meaning it's not part of the query but is required for proper navigability.

RangeVariableDeclaration	back to summary
public RangeVariableDeclaration(AbstractExpression parent) Creates a new `RangeVariableDeclaration`. Parameters parent:AbstractExpression The parent of this expression

RangeVariableDeclaration	back to summary
public RangeVariableDeclaration(String entityName, String variableName) Creates a new `RangeVariableDeclaration`, which is used as a virtual declaration. Parameters entityName:String The name of the entity to be accessible with the given variable name variableName:String The identification variable used to navigate to the entity

Method Detail

accept back to summary

accept	back 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

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

acceptChildren back to summary

acceptChildren	back 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

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

addChildrenTo back to summary

addChildrenTo	back 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

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

addOrderedChildrenTo back to summary

addOrderedChildrenTo	back 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

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

findQueryBNF back to summary

findQueryBNF	back 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

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

getActualAsIdentifier	back 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

getActualAsIdentifier

back 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

getIdentificationVariable back to summary

getIdentificationVariable	back to summary
public Expression getIdentificationVariable() Returns the `Expression` that represents the identification variable. Returns:Expression The expression that was parsed representing the identification variable

public Expression getIdentificationVariable()

Returns the Expression that represents the identification variable.

Returns:Expression: The expression that was parsed representing the identification variable

getQueryBNF back to summary

getQueryBNF	back 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

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

getRootObject back to summary

getRootObject	back to summary
public Expression getRootObject() Returns the `Expression` that represents the "root" object. Returns:Expression The expression that was parsed representing the "root" object

public Expression getRootObject()

Returns the Expression that represents the "root" object.

Returns:Expression: The expression that was parsed representing the "root" object

hasAs back to summary

hasAs	back to summary
public boolean hasAs() Determines whether the identifier AS was parsed. Returns:boolean `true` if the identifier AS was parsed; `false` otherwise

public boolean hasAs()

Determines whether the identifier AS was parsed.

Returns:boolean: true if the identifier AS was parsed; false otherwise

hasIdentificationVariable back to summary

hasIdentificationVariable	back to summary
public boolean hasIdentificationVariable() Determines whether the identification variable was parsed. Returns:boolean `true` if the identification variable was parsed; `false` otherwise

public boolean hasIdentificationVariable()

Determines whether the identification variable was parsed.

Returns:boolean: true if the identification variable was parsed; false otherwise

hasRootObject back to summary

hasRootObject	back to summary
public boolean hasRootObject() Determines whether the "root" object was parsed. Returns:boolean `true` if the "root" object was parsed; `false` otherwise

public boolean hasRootObject()

Determines whether the "root" object was parsed.

Returns:boolean: true if the "root" object was parsed; false otherwise

hasSpaceAfterAs back to summary

hasSpaceAfterAs	back 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

public boolean hasSpaceAfterAs()

Determines whether a whitespace was parsed after AS.

Returns:boolean: true if there was a whitespace after AS; false otherwise

hasSpaceAfterRootObject back to summary

hasSpaceAfterRootObject	back to summary
public boolean hasSpaceAfterRootObject() Determines whether a whitespace was parsed after the "root" object. Returns:boolean `true` if there was a whitespace after "root" object; `false` otherwise

public boolean hasSpaceAfterRootObject()

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

Returns:boolean: true if there was a whitespace after "root" object; false otherwise

hasVirtualIdentificationVariable back to summary

hasVirtualIdentificationVariable	back to summary
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:boolean `true` if this identification variable was virtually created to fully qualify path expression; `false` if it was parsed

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:boolean: true if this identification variable was virtually created to fully qualify path expression; false if it was parsed

isParsingComplete back to summary

isParsingComplete	back 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

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

parse back to summary

parse	back 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

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

setVirtualIdentificationVariable back to summary

setVirtualIdentificationVariable	back to summary
public void setVirtualIdentificationVariable(String variableName) Sets a virtual identification variable because the "root" object was parsed without one. This is valid in an UPDATE and DELETE queries. Example: `UPDATE DateTime SET date = CURRENT_DATE` is equivalent to `UPDATE DateTime d SET d.date = CURRENT_DATE` Parameters variableName:String A virtual identification variable that will identify the "root" object

public void setVirtualIdentificationVariable(String variableName)

Sets a virtual identification variable because the "root" object was parsed without one. This is valid in an UPDATE and DELETE queries. Example:

UPDATE DateTime SET date = CURRENT_DATE

is equivalent to

UPDATE DateTime d SET d.date = CURRENT_DATE

Parameters

variableName:String: A virtual identification variable that will identify the "root" object

setVirtualIdentificationVariable back to summary

setVirtualIdentificationVariable	back to summary
public void setVirtualIdentificationVariable(String variableName, String path) Sets a virtual identification variable to qualify the "root" object. The "root" object is a derived path that does not start with an identification variable. Example: `UPDATE Employee SET firstName = 'MODIFIED' WHERE (SELECT COUNT(m) FROM managedEmployees m) > 0` 'managedEmployees' is a derived path and will become qualified with the given virtual identification variable. Parameters variableName:String The identification variable that was generated to qualify the "root" object path:String The path that was parsed as a "root" object

public void setVirtualIdentificationVariable(String variableName, String path)

Sets a virtual identification variable to qualify the "root" object. The "root" object is a derived path that does not start with an identification variable. Example:

UPDATE Employee SET firstName = 'MODIFIED' WHERE (SELECT COUNT(m) FROM managedEmployees m) > 0

'managedEmployees' is a derived path and will become qualified with the given virtual identification variable.

Parameters

variableName:String: The identification variable that was generated to qualify the "root" object
path:String: The path that was parsed as a "root" object

shouldParseWithFactoryFirst back to summary

shouldParseWithFactoryFirst	back to summary
protected boolean shouldParseWithFactoryFirst() Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.shouldParseWithFactoryFirst. Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.shouldParseWithFactoryFirst. Determines whether the parsing of the query should be performed using the `factories` first or it should automatically fallback to the fallback factory. Returns:boolean `true` is returned by default so the factories are used before falling back Annotations @Override

protected boolean shouldParseWithFactoryFirst()

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

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

Determines whether the parsing of the query should be performed using the factories first or it should automatically fallback to the fallback factory.

Returns:boolean

true is returned by default so the factories are used before falling back

Annotations

@Override

toParsedText back to summary

toParsedText	back 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

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

public final Class RangeVariableDeclaration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail