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

public final Class OnClause

extends AbstractConditionalClause
Class Inheritance
Imports
org.eclipse.persistence.jpa.jpql.WordParser
Returns an expression that allows a join ON clause to be defined.

New to EclipseLink 2.4 and JPA 2.1.

BNF: join_condition ::= ON conditional_expression

Example: SELECT e FROM Employee e LEFT JOIN e.projects p ON p.budget > 10000

Author
James Sutherland
Since
2.4
Version
2.4

Constructor Summary

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

Creates a new OnClause.

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

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

Returns the BNF of this 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.AbstractConditionalClause.isParsingComplete.

Determines whether the parsing is complete based on what is left in the given text.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractConditionalClause:
acceptChildrenaddChildrenToaddOrderedChildrenTobuildCollectionExpressionfindQueryBNFgetActualIdentifiergetConditionalExpressiongetIdentifierhasConditionalExpressionhasSpaceAfterIdentifierparseshouldSkipLiteraltoParsedText

Constructor Detail

OnClauseback to summary
public OnClause(AbstractExpression parent)

Creates a new OnClause.

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
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
isParsingCompleteback to summary
protected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractConditionalClause.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