public final class Join extends AbstractExpression
join ::= join_spec join_association_path_expression [AS] identification_variableA JOIN FETCH enables the fetching of an association as a side effect of the execution of a query. A JOIN FETCH is specified over an entity and its related entities.
fetch_join ::= join_spec FETCH join_association_path_expressionEclipseLink 2.4
join_spec { abstract_schema_name | join_association_path_expression } [AS] identification_variable [join_condition]COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCOREABS, 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 and Description |
|---|
Join(AbstractExpression parent,
String identifier)
Creates a new
Join. |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(ExpressionVisitor visitor)
Visits this
Expression by the given visitor. |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this
Expression. |
protected void |
addChildrenTo(Collection<Expression> children)
Adds the children of this
AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(List<Expression> children)
Adds the children of this
AbstractExpression to the given list. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
String |
getActualAsIdentifier()
Returns the actual AS found in the string representation of the JPQL query, which has
the actual case that was used.
|
String |
getActualIdentifier()
Returns the actual identifier found in the string representation of the JPQL query, which has
the actual case that was used.
|
Expression |
getIdentificationVariable()
Returns the
Expression that represents the identification variable. |
String |
getIdentifier()
Returns the identifier this expression represents.
|
Expression |
getJoinAssociationPath()
Returns the
Expression that represents the join association path expression. |
Expression |
getOnClause()
Returns the
Expression that represents the ON clause if present. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this
Expression. |
boolean |
hasAs()
Determines whether the identifier AS was parsed.
|
boolean |
hasFetch()
Determines whether the identifier FETCH was parsed.
|
boolean |
hasIdentificationVariable()
Determines whether the identification variable was parsed.
|
boolean |
hasJoinAssociationPath()
Determines whether the join association path expression was parsed.
|
boolean |
hasOnClause()
Determines whether the ON clause was parsed.
|
boolean |
hasSpaceAfterAs()
Determines whether a whitespace was parsed after AS.
|
boolean |
hasSpaceAfterIdentificationVariable()
Determines whether a whitespace was parsed before ON.
|
boolean |
hasSpaceAfterJoin()
Determines whether a whitespace was parsed after JOIN.
|
boolean |
hasSpaceAfterJoinAssociation()
Determines whether a whitespace was parsed after the join association path expression.
|
boolean |
isLeftJoin()
Determines whether this
Join is a left join, i.e. |
protected boolean |
isParsingComplete(WordParser wordParser,
String word,
Expression expression)
Determines whether the parsing is complete based on what is left in the given text.
|
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given
WordParser. |
protected void |
toParsedText(StringBuilder writer,
boolean actual)
Generates a string representation of this
Expression, including its children,
if it has any. |
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, shouldSkipLiteral, toActualText, toParsedText, toStringpublic Join(AbstractExpression parent, String identifier)
Join.parent - The parent of this expressionidentifier - The full JOIN identifierpublic void accept(ExpressionVisitor visitor)
Expression by the given visitor.visitor - The ExpressionVisitor to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
Expression. This method can be used to optimize traversing
the children since a new list is not created every time Expression.children() is called.
This does not traverse the Expression sub-hierarchy, use a subclass of
AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.
visitor - The visitor to visit the children of this object.protected void addChildrenTo(Collection<Expression> children)
AbstractExpression to the given collection.addChildrenTo in class AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedChildrenTo(List<Expression> children)
AbstractExpression to the given list.addOrderedChildrenTo in class AbstractExpressionchildren - The list used to store the string representation of this AbstractExpressionpublic JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression.findQueryBNF in interface ExpressionfindQueryBNF in class AbstractExpressionexpression - The Expression that is a descendant of this oneJPQLQueryBNF that was used to parse the given expressionpublic String getActualAsIdentifier()
public String getActualIdentifier()
public Expression getIdentificationVariable()
Expression that represents the identification variable.public String getIdentifier()
public Expression getJoinAssociationPath()
Expression that represents the join association path expression.public Expression getOnClause()
Expression that represents the ON clause if present.public JPQLQueryBNF getQueryBNF()
Expression.JPQLQueryBNF, which represents the grammar of this Expressionpublic boolean hasAs()
true if the identifier AS was parsed; false otherwisepublic boolean hasFetch()
true if the identifier FETCH was parsed; false otherwisepublic boolean hasIdentificationVariable()
true if the identification variable was parsed; false otherwisepublic boolean hasJoinAssociationPath()
true if the join association path expression was parsed; false
otherwisepublic boolean hasOnClause()
true if the ON clause was parsed; false otherwisepublic boolean hasSpaceAfterAs()
true if there was a whitespace after AS; false
otherwisepublic boolean hasSpaceAfterIdentificationVariable()
true if there was a whitespace before ON; false
otherwisepublic boolean hasSpaceAfterJoin()
true if there was a whitespace after JOIN; false otherwisepublic boolean hasSpaceAfterJoinAssociation()
true if there was a whitespace after join association path expression;
false otherwisepublic boolean isLeftJoin()
Join is a left join, i.e. Expression.LEFT_JOIN,
Expression.LEFT_JOIN_FETCH, Expression.LEFT_OUTER_JOIN, Expression.LEFT_OUTER_JOIN_FETCH.true if this Join expression is a Expression.LEFT_JOIN,
Expression.LEFT_JOIN_FETCH, Expression.LEFT_OUTER_JOIN, Expression.LEFT_OUTER_JOIN_FETCH; false otherwiseprotected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)
isParsingComplete in class AbstractExpressionwordParser - The text to parse based on the current position of the cursorword - The word that was retrieved from the given text, which is the first word in the textexpression - The Expression that has already been parsedtrue if the text no longer can't be parsed by the current expression;
false if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser.parse in class AbstractExpressionwordParser - The text to parse based on the current position of the cursortolerant - Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queriesprotected void toParsedText(StringBuilder writer, boolean actual)
Expression, including its children,
if it has any.toParsedText in class AbstractExpressionwriter - The buffer used to append this Expression's string representationactual - 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 identifiersCopyright © 2007–2021 Eclipse.org - EclipseLink Project. All rights reserved.