Class JPQLExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.JPQLExpression
-
- All Implemented Interfaces:
Expression
public final class JPQLExpression extends AbstractExpression
AJPQLExpressionis the root of the parsed tree representation of a JPQL query. The query is parsed based on what was registered in theJPQLGrammar'sExpressionRegistry.A JPQL statement may be either a SELECT statement, an UPDATE statement, or a DELETE FROM statement.
BNF:QL_statement ::=select_statement|update_statement|delete_statementIt is possible to parse a portion of a JPQL query. The ID of the
JPQLQueryBNFis used to parse that portion andgetQueryStatement()then returns only the parsed tree representation of that JPQL fragment.- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.3
-
-
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 JPQLExpression(java.lang.CharSequence query, JPQLGrammar jpqlGrammar)Creates a newJPQLExpression, which is the root of the JPQL parsed tree.JPQLExpression(java.lang.CharSequence query, JPQLGrammar jpqlGrammar, boolean tolerant)Creates a newJPQLExpression, which is the root of the JPQL parsed tree.JPQLExpression(java.lang.CharSequence jpqlFragment, JPQLGrammar jpqlGrammar, java.lang.String queryBNFId, boolean tolerant)Creates a newJPQLExpressionthat will parse the given fragment of a JPQL query.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.QueryPositionbuildPosition(java.lang.String actualQuery, int position)Creates a map of the position of the cursor within eachExpressionof the parsed tree.ExpressiongetExpression(java.lang.String actualQuery, int position)Returns the deepestExpressionfor the given position.JPQLGrammargetGrammar()Returns theJPQLGrammarthat defines how the JPQL query was parsed.JPAVersiongetJPAVersion()Returns the version of the Java Persistence to support.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.ExpressiongetQueryStatement()Returns theExpressionrepresenting the query, which is either a SELECT, a DELETE or an UPDATE clause.ExpressiongetUnknownEndingStatement()Returns theExpressionthat may contain a portion of the query that could not be parsed, this happens when the query is either incomplete or malformed.booleanhasQueryStatement()Determines whether a query was parsed.booleanhasUnknownEndingStatement()Determines whether the query that got parsed had some malformed or unknown information.protected booleanisTolerant()Determines if the parser is in tolerant mode or is in fast mode.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, findQueryBNF, getExpressionFactory, getExpressionRegistry, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isParsingComplete, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
JPQLExpression
public JPQLExpression(java.lang.CharSequence query, JPQLGrammar jpqlGrammar)Creates a newJPQLExpression, which is the root of the JPQL parsed tree.- Parameters:
query- The string representation of the JPQL query to parsejpqlGrammar- The JPQL grammar that defines how to parse a JPQL query
-
JPQLExpression
public JPQLExpression(java.lang.CharSequence query, JPQLGrammar jpqlGrammar, boolean tolerant)Creates a newJPQLExpression, which is the root of the JPQL parsed tree.- Parameters:
query- The string representation of the JPQL query to parsejpqlGrammar- The JPQL grammar that defines how to parse a JPQL querytolerant- Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
JPQLExpression
public JPQLExpression(java.lang.CharSequence jpqlFragment, JPQLGrammar jpqlGrammar, java.lang.String queryBNFId, boolean tolerant)Creates a newJPQLExpressionthat will parse the given fragment of a JPQL query. This meansgetQueryStatement()will not return a query statement (select, delete or update) but only the parsed tree representation of the fragment if the query BNF can pare it. If the fragment of the JPQL query could not be parsed using the givenJPQLQueryBNF, thengetUnknownEndingStatement()will contain the non-parsable fragment.- Parameters:
jpqlFragment- A fragment of a JPQL query, which is a portion of a complete JPQL queryjpqlGrammar- The JPQL grammar that defines how to parse a JPQL queryqueryBNFId- The unique identifier of theJPQLQueryBNFtolerant- Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries- Since:
- 2.4
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()is called.This does not traverse the
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
buildPosition
public QueryPosition buildPosition(java.lang.String actualQuery, int position)
Creates a map of the position of the cursor within eachExpressionof the parsed tree.- Parameters:
actualQuery- The actual query is a string representation of the query that may contain extra whitespaceposition- The position of the cursor in the actual query, which is used to retrieve the deepestExpression. The position will be adjusted to fit into the beautified version of the query- Returns:
- A new
QueryPosition
-
getExpression
public Expression getExpression(java.lang.String actualQuery, int position)
Returns the deepestExpressionfor the given position.- Parameters:
actualQuery- The actual query is the text version of the query that may contain extra whitespace and different formatting than the trim down version generated by the parsed treeposition- The position in the actual query used to retrieve theExpression- Returns:
- The
Expressionlocated at the given position in the given query
-
getGrammar
public JPQLGrammar getGrammar()
Returns theJPQLGrammarthat defines how the JPQL query was parsed.- Specified by:
getGrammarin interfaceExpression- Overrides:
getGrammarin classAbstractExpression- Returns:
- The
JPQLGrammarthat was used to parse thisExpression
-
getJPAVersion
public JPAVersion getJPAVersion()
Returns the version of the Java Persistence to support.- Overrides:
getJPAVersionin classAbstractExpression- Returns:
- The JPA version supported by the grammar
- See Also:
JPQLGrammar
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
getQueryStatement
public Expression getQueryStatement()
Returns theExpressionrepresenting the query, which is either a SELECT, a DELETE or an UPDATE clause.- Returns:
- The expression representing the Java Persistence query
-
getUnknownEndingStatement
public Expression getUnknownEndingStatement()
Returns theExpressionthat may contain a portion of the query that could not be parsed, this happens when the query is either incomplete or malformed.- Returns:
- The expression used when the ending of the query is unknown or malformed
-
hasQueryStatement
public boolean hasQueryStatement()
Determines whether a query was parsed. The query may be incomplete but it started with one of the three clauses (SELECT, DELETE FROM, or UPDATE).- Returns:
truethe query was parsed;falseotherwise
-
hasUnknownEndingStatement
public boolean hasUnknownEndingStatement()
Determines whether the query that got parsed had some malformed or unknown information.- Returns:
trueif the query could not be parsed correctly because it is either incomplete or malformed
-
isTolerant
protected boolean isTolerant()
Determines if the parser is in tolerant mode or is in fast mode. When the tolerant is turned on, it means the parser will attempt to parse incomplete or invalid queries.- Overrides:
isTolerantin classAbstractExpression- Returns:
trueif the parsing system should parse invalid or incomplete queries;falsewhen the query is well-formed and valid
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
wordParser- 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 queries
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression'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 identifiers
-
-