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

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	hasSpaceAfterIdentificationVariable Determines whether a whitespace was parsed after the identification variable.
private boolean	hasSpaceAfterJoin Determines whether a whitespace was parsed after JOIN.
private boolean	hasSpaceAfterJoinAssociation Determines whether a whitespace was parsed after the join association path expression.
private AbstractExpression	identificationVariable The `Expression` representing the identification variable.
private AbstractExpression	joinAssociationPath The `Expression` representing the join association path expression.
private String	joinIdentifier The actual JOIN identifier found in the string representation of the JPQL query.
private AbstractExpression	onClause The `Expression` representing the join ON clause.
private boolean	parsingIdentificationVariable Make sure when parsing the identification variable with tolerance turned on, a the join condition identifier ON is not parsed.

Access	Constructor and Description
public	Join(AbstractExpression The parent of this expression parent, String The full JOIN identifier identifier) Creates a new `Join`.

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 String	Returns: The identifier identifier that was actually parsed getActualIdentifier() Returns the actual identifier 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 String	Returns: Either JOIN, INNER JOIN, LEFT JOIN or LEFT OUTER JOIN. Although it's possible to have an incomplete identifier if the query is not complete getIdentifier() Returns the identifier this expression represents.
public Expression	Returns: The expression that was parsed representing the join association path expression getJoinAssociationPath() Returns the `Expression` that represents the join association path expression.
public Expression	Returns: The expression that was parsed representing the identification variable getOnClause() Returns the `Expression` that represents the ON clause if present.
public JPQLQueryBNF	getQueryBNF() Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF. Returns the BNF of this `Expression`.
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 identifier FETCH was parsed; `false` otherwise hasFetch() Determines whether the identifier FETCH 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 join association path expression was parsed; `false` otherwise hasJoinAssociationPath() Determines whether the join association path expression was parsed.
public boolean	Returns: `true` if the ON clause was parsed; `false` otherwise hasOnClause() Determines whether the ON clause 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 before ON; `false` otherwise hasSpaceAfterIdentificationVariable() Determines whether a whitespace was parsed before ON.
public boolean	Returns: `true` if there was a whitespace after JOIN; `false` otherwise hasSpaceAfterJoin() Determines whether a whitespace was parsed after JOIN.
public boolean	Returns: `true` if there was a whitespace after join association path expression; `false` otherwise hasSpaceAfterJoinAssociation() Determines whether a whitespace was parsed after the join association path expression.
public boolean	Returns: `true` if this `Join` expression is a `Expression#LEFT_JOIN`, `Expression#LEFT_JOIN_FETCH`, `Expression#LEFT_OUTER_JOIN`, `Expression#LEFT_OUTER_JOIN_FETCH`; `false` otherwise isLeftJoin() Determines whether this `Join` is a left join, i.e. `Expression#LEFT_JOIN`, `Expression#LEFT_JOIN_FETCH`, `Expression#LEFT_OUTER_JOIN`, `Expression#LEFT_OUTER_JOIN_FETCH`.
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.

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.

hasSpaceAfterIdentificationVariable	back to summary
private boolean hasSpaceAfterIdentificationVariable Determines whether a whitespace was parsed after the identification variable.

hasSpaceAfterJoin	back to summary
private boolean hasSpaceAfterJoin Determines whether a whitespace was parsed after JOIN.

hasSpaceAfterJoinAssociation	back to summary
private boolean hasSpaceAfterJoinAssociation Determines whether a whitespace was parsed after the join association path expression.

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

joinAssociationPath	back to summary
private AbstractExpression joinAssociationPath The `Expression` representing the join association path expression.

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

onClause	back to summary
private AbstractExpression onClause The `Expression` representing the join ON clause.

parsingIdentificationVariable	back to summary
private boolean parsingIdentificationVariable Make sure when parsing the identification variable with tolerance turned on, a the join condition identifier ON is not parsed.

Join	back to summary
public Join(AbstractExpression parent, String identifier) Creates a new `Join`. Parameters parent:AbstractExpression The parent of this expression identifier:String The full JOIN identifier

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

getActualIdentifier	back to summary
public String getActualIdentifier() Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used. Returns:String The identifier identifier that was actually parsed

getActualIdentifier

back to summary

public String getActualIdentifier()

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

Returns:String: The identifier identifier that was actually 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

getIdentifier	back to summary
public String getIdentifier() Returns the identifier this expression represents. Returns:String Either JOIN, INNER JOIN, LEFT JOIN or LEFT OUTER JOIN. Although it's possible to have an incomplete identifier if the query is not complete

getIdentifier

back to summary

public String getIdentifier()

Returns the identifier this expression represents.

Returns:String: Either JOIN, INNER JOIN, LEFT JOIN or LEFT OUTER JOIN. Although it's possible to have an incomplete identifier if the query is not complete

getJoinAssociationPath back to summary

getJoinAssociationPath	back to summary
public Expression getJoinAssociationPath() Returns the `Expression` that represents the join association path expression. Returns:Expression The expression that was parsed representing the join association path expression

public Expression getJoinAssociationPath()

Returns the Expression that represents the join association path expression.

Returns:Expression: The expression that was parsed representing the join association path expression

getOnClause back to summary

getOnClause	back to summary
public Expression getOnClause() Returns the `Expression` that represents the ON clause if present. Returns:Expression The expression that was parsed representing the identification variable

public Expression getOnClause()

Returns the Expression that represents the ON clause if present.

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

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

hasFetch back to summary

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

public boolean hasFetch()

Determines whether the identifier FETCH was parsed.

Returns:boolean: true if the identifier FETCH 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

hasJoinAssociationPath back to summary

hasJoinAssociationPath	back to summary
public boolean hasJoinAssociationPath() Determines whether the join association path expression was parsed. Returns:boolean `true` if the join association path expression was parsed; `false` otherwise

public boolean hasJoinAssociationPath()

Determines whether the join association path expression was parsed.

Returns:boolean: true if the join association path expression was parsed; false otherwise

hasOnClause back to summary

hasOnClause	back to summary
public boolean hasOnClause() Determines whether the ON clause was parsed. Returns:boolean `true` if the ON clause was parsed; `false` otherwise

public boolean hasOnClause()

Determines whether the ON clause was parsed.

Returns:boolean: true if the ON clause 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

hasSpaceAfterIdentificationVariable back to summary

hasSpaceAfterIdentificationVariable	back to summary
public boolean hasSpaceAfterIdentificationVariable() Determines whether a whitespace was parsed before ON. Returns:boolean `true` if there was a whitespace before ON; `false` otherwise

public boolean hasSpaceAfterIdentificationVariable()

Determines whether a whitespace was parsed before ON.

Returns:boolean: true if there was a whitespace before ON; false otherwise

hasSpaceAfterJoin back to summary

hasSpaceAfterJoin	back to summary
public boolean hasSpaceAfterJoin() Determines whether a whitespace was parsed after JOIN. Returns:boolean `true` if there was a whitespace after JOIN; `false` otherwise

public boolean hasSpaceAfterJoin()

Determines whether a whitespace was parsed after JOIN.

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

hasSpaceAfterJoinAssociation back to summary

hasSpaceAfterJoinAssociation	back to summary
public boolean hasSpaceAfterJoinAssociation() Determines whether a whitespace was parsed after the join association path expression. Returns:boolean `true` if there was a whitespace after join association path expression; `false` otherwise

public boolean hasSpaceAfterJoinAssociation()

Determines whether a whitespace was parsed after the join association path expression.

Returns:boolean: true if there was a whitespace after join association path expression; false otherwise

isLeftJoin back to summary

isLeftJoin	back to summary
public boolean isLeftJoin() Determines whether this `Join` is a left join, i.e. `Expression#LEFT_JOIN`, `Expression#LEFT_JOIN_FETCH`, `Expression#LEFT_OUTER_JOIN`, `Expression#LEFT_OUTER_JOIN_FETCH`. Returns:boolean `true` if this `Join` expression is a `Expression#LEFT_JOIN`, `Expression#LEFT_JOIN_FETCH`, `Expression#LEFT_OUTER_JOIN`, `Expression#LEFT_OUTER_JOIN_FETCH`; `false` otherwise

public boolean isLeftJoin()

Determines whether this Join is a left join, i.e. Expression#LEFT_JOIN, Expression#LEFT_JOIN_FETCH, Expression#LEFT_OUTER_JOIN, Expression#LEFT_OUTER_JOIN_FETCH.

Returns:boolean: true if this Join expression is a Expression#LEFT_JOIN, Expression#LEFT_JOIN_FETCH, Expression#LEFT_OUTER_JOIN, Expression#LEFT_OUTER_JOIN_FETCH; false otherwise

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

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 Join

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail