Class UpdateClause
java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.UpdateClause
- All Implemented Interfaces:
Expression
This is the update clause of the update statement.
An UPDATE statement provides bulk operations over sets of entities of a single entity class (together with its subclasses, if any). Only one entity abstract schema type may be specified in the UPDATE clause.
BNF:
update_clause ::= UPDATE abstract_schema_name [[AS] identification_variable] SET update_item {, update_item}*
- Since:
- 2.3
- Version:
- 2.5
- See Also:
-
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, CEILING, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DATE, DATETIME, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXP, EXTRACT, FALSE, FETCH, FIRST, FLOOR, 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, LN, LOCAL, 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, POWER, QUOTE, REGEXP, ROUND, SCN, SELECT, SET, SIGN, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIME, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ExpressionVisitor visitor) Visits thisExpression
by the givenvisitor
.void
acceptChildren
(ExpressionVisitor visitor) Visits the children of thisExpression
.protected void
addChildrenTo
(Collection<Expression> children) Adds the children of thisAbstractExpression
to the given collection.protected void
addOrderedChildrenTo
(List<Expression> children) Adds the children of thisAbstractExpression
to the given list.Creates a newCollectionExpression
that will wrap the single update item.findQueryBNF
(Expression expression) Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.Returns the actual SET found in the string representation of the JPQL query, which has the actual case that was used.Returns the actual UPDATE found in the string representation of the JPQL query, which has the actual case that was used.Returns the BNF of thisExpression
.Returns theExpression
representing the range variable declaration.Returns theExpression
representing the single update item or the collection of update items.boolean
Determines whether the range variable declaration was parsed.boolean
hasSet()
Determines whether SET was parsed or not.boolean
Determines whether a whitespace was found after the abstract schema name declaration.boolean
Determines whether a whitespace was found after SET.boolean
Determines whether a whitespace was found after the identifier UPDATE.boolean
Determines whether the update items section of the query was parsed.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 givenWordParser
.protected void
toParsedText
(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, 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, toString
-
Constructor Details
-
UpdateClause
Creates a newUpdateClause
.- Parameters:
parent
- The parent of this expression
-
-
Method Details
-
accept
Description copied from interface:Expression
Visits thisExpression
by the givenvisitor
.- Parameters:
visitor
- TheExpressionVisitor
to visit this object
-
acceptChildren
Description copied from interface:Expression
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
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
addChildrenTo
Description copied from class:AbstractExpression
Adds the children of thisAbstractExpression
to the given collection.- Overrides:
addChildrenTo
in classAbstractExpression
- Parameters:
children
- The collection used to store the children
-
addOrderedChildrenTo
Description copied from class:AbstractExpression
Adds the children of thisAbstractExpression
to the given list.- Overrides:
addOrderedChildrenTo
in classAbstractExpression
- Parameters:
children
- The list used to store the string representation of thisAbstractExpression
-
buildCollectionExpression
Creates a newCollectionExpression
that will wrap the single update item.- Returns:
- The single update item represented by a temporary collection
-
findQueryBNF
Description copied from interface:Expression
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.- Specified by:
findQueryBNF
in interfaceExpression
- Overrides:
findQueryBNF
in classAbstractExpression
- Parameters:
expression
- TheExpression
that is a descendant of this one- Returns:
- The
JPQLQueryBNF
that was used to parse the given expression
-
getActualSetIdentifier
Returns the actual SET found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The SET identifier that was actually parsed, or an empty string if it was not parsed
-
getActualUpdateIdentifier
Returns the actual UPDATE found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The UPDATE identifier that was actually parsed
-
getQueryBNF
Description copied from interface:Expression
Returns the BNF of thisExpression
.- Returns:
- The
JPQLQueryBNF
, which represents the grammar of thisExpression
-
getRangeVariableDeclaration
Returns theExpression
representing the range variable declaration.- Returns:
- The expression that was parsed representing the range variable declaration
-
getUpdateItems
Returns theExpression
representing the single update item or the collection of update items.- Returns:
- The expression that was parsed representing the single or multiple update items
-
hasRangeVariableDeclaration
public boolean hasRangeVariableDeclaration()Determines whether the range variable declaration was parsed.- Returns:
true
if the range variable declaration was parsed;false
otherwise
-
hasSet
public boolean hasSet()Determines whether SET was parsed or not.- Returns:
true
if SET was part of the query;false
otherwise
-
hasSpaceAfterRangeVariableDeclaration
public boolean hasSpaceAfterRangeVariableDeclaration()Determines whether a whitespace was found after the abstract schema name declaration.- Returns:
true
if there was a whitespace after the abstract schema name declaration;false
otherwise
-
hasSpaceAfterSet
public boolean hasSpaceAfterSet()Determines whether a whitespace was found after SET.- Returns:
true
if there was a whitespace after SET;false
otherwise
-
hasSpaceAfterUpdate
public boolean hasSpaceAfterUpdate()Determines whether a whitespace was found after the identifier UPDATE.- Returns:
true
if there was a whitespace after the identifier UPDATE;false
otherwise
-
hasUpdateItems
public boolean hasUpdateItems()Determines whether the update items section of the query was parsed.- Returns:
true
if something was parsed after SET even if it was a malformed expression;false
if nothing was parsed
-
isParsingComplete
Description copied from class:AbstractExpression
Determines whether the parsing is complete based on what is left in the given text. The text is never empty.- Overrides:
isParsingComplete
in classAbstractExpression
- Parameters:
wordParser
- 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
- TheExpression
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
-
parse
Description copied from class:AbstractExpression
Parses the query by starting at the current position, which is part of the givenWordParser
.- Specified by:
parse
in 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
Description copied from class:AbstractExpression
Generates a string representation of thisExpression
, including its children, if it has any.- Specified by:
toParsedText
in 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
-