org.eclipse.persistence.jpa.internal.jpql.parser

Class UpdateClause

java.lang.Object

org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression

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

org.eclipse.persistence.jpa.internal.jpql.parser.UpdateClause

All Implemented Interfaces:

Expression

public final class UpdateClause
extends AbstractExpression

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.3

Author:

Pascal Filion

See Also:

UpdateStatement, UpdateItem

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.internal.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.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

Methods

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	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.

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

children, findQueryBNF, getChildren, getParent, getRoot, identifierRole, identifiers, identifierVersion, isAncestor, isIdentifier, isVirtual, orderedChildren, queryBNF, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The visitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() or Expression.getChildren() is called.

This does not traverse the Expression sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters:

visitor - The visitor to visit the children of this object.

buildCollectionExpression

public CollectionExpression buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single update item.

Returns:

The single update item represented by a temporary collection

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

getRangeVariableDeclaration

public Expression getRangeVariableDeclaration()

Returns the Expression representing the range variable declaration.

Returns:

The expression that was parsed representing the range variable declaration

getUpdateItems

public Expression getUpdateItems()

Returns the Expression 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