Package org.eclipse.persistence.jpa.jpql.parser

Class OnClause

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.AbstractConditionalClause

org.eclipse.persistence.jpa.jpql.parser.OnClause

All Implemented Interfaces:

Expression

public final class OnClause
extends AbstractConditionalClause

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

Version:

2.4

Author:

James Sutherland

Since:

2.4

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE

Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

Constructors

Constructor	Description
OnClause(AbstractExpression parent)	Creates a new OnClause.

Method Summary

Modifier and Type	Method	Description
void	accept(ExpressionVisitor visitor)	Visits this Expression by the given visitor.
JPQLQueryBNF	getQueryBNF()	Returns the BNF of this Expression.
protected boolean	isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)	Determines whether the parsing is complete based on what is left in the given text.

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractConditionalClause

acceptChildren, addChildrenTo, addOrderedChildrenTo, buildCollectionExpression, findQueryBNF, getActualIdentifier, getConditionalExpression, getIdentifier, hasConditionalExpression, hasSpaceAfterIdentifier, parse, shouldSkipLiteral, toParsedText

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OnClause

public OnClause(AbstractExpression parent)

Creates a new OnClause.

Parameters:

parent - The parent of this expression

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The ExpressionVisitor to visit this object

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

isParsingComplete

protected boolean isParsingComplete(WordParser wordParser,
                                    java.lang.String word,
                                    Expression expression)

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

Overrides:

isParsingComplete in class AbstractConditionalClause

Parameters:

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

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

expression - The Expression that has already been parsed

Returns:

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