public final class UpdateClause extends AbstractExpression
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.
update_clause ::= UPDATE abstract_schema_name [[AS] identification_variable] SET update_item {, update_item}*UpdateStatement,
UpdateItemCOMMA, 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 |
|---|
UpdateClause(AbstractExpression parent)
Creates a new
UpdateClause. |
| 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. |
CollectionExpression |
buildCollectionExpression()
Creates a new
CollectionExpression that will wrap the single update item. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the
JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
java.lang.String |
getActualSetIdentifier()
Returns the actual SET found in the string representation of the JPQL query, which has
the actual case that was used.
|
java.lang.String |
getActualUpdateIdentifier()
Returns the actual UPDATE found in the string representation of the JPQL query, which
has the actual case that was used.
|
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this
Expression. |
Expression |
getRangeVariableDeclaration()
Returns the
Expression representing the range variable declaration. |
Expression |
getUpdateItems()
Returns the
Expression representing the single update item or the collection of update items. |
boolean |
hasRangeVariableDeclaration()
Determines whether the range variable declaration was parsed.
|
boolean |
hasSet()
Determines whether SET was parsed or not.
|
boolean |
hasSpaceAfterRangeVariableDeclaration()
Determines whether a whitespace was found after the abstract schema name declaration.
|
boolean |
hasSpaceAfterSet()
Determines whether a whitespace was found after SET.
|
boolean |
hasSpaceAfterUpdate()
Determines whether a whitespace was found after the identifier UPDATE.
|
boolean |
hasUpdateItems()
Determines whether the update items section of the query was parsed.
|
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toStringpublic UpdateClause(AbstractExpression parent)
UpdateClause.parent - The parent of this expressionpublic 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.public CollectionExpression buildCollectionExpression()
CollectionExpression that will wrap the single update item.public 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 java.lang.String getActualSetIdentifier()
public java.lang.String getActualUpdateIdentifier()
public JPQLQueryBNF getQueryBNF()
Expression.JPQLQueryBNF, which represents the grammar of this Expressionpublic Expression getRangeVariableDeclaration()
Expression representing the range variable declaration.public Expression getUpdateItems()
Expression representing the single update item or the collection of update items.public boolean hasRangeVariableDeclaration()
true if the range variable declaration was parsed; false otherwisepublic boolean hasSet()
true if SET was part of the query; false otherwisepublic boolean hasSpaceAfterRangeVariableDeclaration()
true if there was a whitespace after the abstract schema name declaration;
false otherwisepublic boolean hasSpaceAfterSet()
true if there was a whitespace after SET; false otherwisepublic boolean hasSpaceAfterUpdate()
true if there was a whitespace after the identifier UPDATE;
false otherwisepublic boolean hasUpdateItems()
true if something was parsed after SET even if it was a malformed
expression; false if nothing was parsedEclipseLink 2.6.3, "build v20160428-59c81c5" API Reference