Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.parser

Class UpdateItem

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.UpdateItem

All Implemented Interfaces:

Expression

public final class UpdateItem
extends AbstractExpression

The new_value specified for an update operation must be compatible in type with the field to which it is assigned.

BNF: update_item ::= [identification_variable.]{state_field | single_valued_association_field} = new_value

Since:

2.3

Version:

2.5

See Also:

• UpdateClause

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

Constructors

Constructor	Description
UpdateItem(AbstractExpression parent)	Creates a new UpdateItem.

Method Summary

Modifier and Type	Method	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.
Expression	getNewValue()	Returns the Expression representing the new value, which is the new value of the property.
JPQLQueryBNF	getQueryBNF()	Returns the BNF of this Expression.
Expression	getStateFieldPathExpression()	Returns the Expression representing the state field path expression, which is the property that should get updated.
boolean	hasEqualSign()	Determines whether the equal sign was parsed or not.
boolean	hasNewValue()	Determines whether the new value section of the query was parsed.
boolean	hasSpaceAfterEqualSign()	Determines whether a whitespace was parsed after the equal sign or not.
boolean	hasSpaceAfterStateFieldPathExpression()	Determines whether a whitespace was parsed after the state field path expression not.
boolean	hasStateFieldPathExpression()	Determines whether the state field 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 given WordParser.
protected void	toParsedText(StringBuilder writer, boolean actual)	Generates a string representation of this Expression, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UpdateItem

public UpdateItem(AbstractExpression parent)

Creates a new UpdateItem.

Parameters:

parent - The parent of this expression

Method Details

accept

public void accept(ExpressionVisitor visitor)

Description copied from interface: Expression

Visits this Expression by the given visitor.

Parameters:

visitor - The ExpressionVisitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

Description copied from interface: Expression

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() is called.

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

Parameters:

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

addChildrenTo

protected void addChildrenTo(Collection<Expression> children)

Description copied from class: AbstractExpression

Adds the children of this AbstractExpression to the given collection.

Overrides:

addChildrenTo in class AbstractExpression

Parameters:

children - The collection used to store the children

addOrderedChildrenTo

protected void addOrderedChildrenTo(List<Expression> children)

Description copied from class: AbstractExpression

Adds the children of this AbstractExpression to the given list.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this AbstractExpression

findQueryBNF

public JPQLQueryBNF findQueryBNF(Expression expression)

Description copied from interface: Expression

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Specified by:

findQueryBNF in interface Expression

Overrides:

findQueryBNF in class AbstractExpression

Parameters:

expression - The Expression that is a descendant of this one

Returns:

The JPQLQueryBNF that was used to parse the given expression

getNewValue

public Expression getNewValue()

Returns the Expression representing the new value, which is the new value of the property.

Returns:

The expression for the new value

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Description copied from interface: Expression

Returns the BNF of this Expression.

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

getStateFieldPathExpression

public Expression getStateFieldPathExpression()

Returns the Expression representing the state field path expression, which is the property that should get updated.

Returns:

The expression for the state field path expression

hasEqualSign

public boolean hasEqualSign()

Determines whether the equal sign was parsed or not.

Returns:

true if the equal sign was parsed; false otherwise

hasNewValue

public boolean hasNewValue()

Determines whether the new value section of the query was parsed.

Returns:

true the new value was parsed; false if nothing was parsed

hasSpaceAfterEqualSign

public boolean hasSpaceAfterEqualSign()

Determines whether a whitespace was parsed after the equal sign or not.

Returns:

true if there was a whitespace after the equal sign; false otherwise

hasSpaceAfterStateFieldPathExpression

public boolean hasSpaceAfterStateFieldPathExpression()

Determines whether a whitespace was parsed after the state field path expression not.

Returns:

true if there was a whitespace after the state field path expression; false otherwise

hasStateFieldPathExpression

public boolean hasStateFieldPathExpression()

Determines whether the state field was parsed.

Returns:

true the state field was parsed; false otherwise

isParsingComplete

protected boolean isParsingComplete(WordParser wordParser,
 String word,
 Expression expression)

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 class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

word - The word that was retrieved from the given text, which is the first word in the text

expression - The Expression 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

protected void parse(WordParser wordParser,
 boolean tolerant)

Description copied from class: AbstractExpression

Parses the query by starting at the current position, which is part of the given WordParser.

Specified by:

parse in class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

toParsedText

protected void toParsedText(StringBuilder writer,
 boolean actual)

Description copied from class: AbstractExpression

Generates a string representation of this Expression, including its children, if it has any.

Specified by:

toParsedText in class AbstractExpression

Parameters:

writer - The buffer used to append this Expression's string representation

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