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

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

Author:

Pascal Filion

See Also:

UpdateClause

Field Summary

private boolean	hasEqualSign Determines whether the equal sign was parsed or not.
private boolean	hasSpaceAfterEqualSign Determines whether a whitespace was parsed after the equal sign or not.
private boolean	hasSpaceAfterStateFieldPathExpression Determines whether a whitespace was parsed before the equal sign or not
private AbstractExpression	newValue The expression representing the new value.
private AbstractExpression	stateFieldExpression The expression representing the state field to have its value updated.

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

Constructor Summary

UpdateItem(AbstractExpression parent)
Creates a new UpdateItem.

Method Summary

void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
(package private) void	addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection.
(package private) void	addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing this 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.
(package private) void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
(package private) void	toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression.

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

buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, 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

Field Detail

hasEqualSign

private boolean hasEqualSign

Determines whether the equal sign was parsed or not.

hasSpaceAfterEqualSign

private boolean hasSpaceAfterEqualSign

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

hasSpaceAfterStateFieldPathExpression

private boolean hasSpaceAfterStateFieldPathExpression

Determines whether a whitespace was parsed before the equal sign or not

newValue

private AbstractExpression newValue

The expression representing the new value.

stateFieldExpression

private AbstractExpression stateFieldExpression

The expression representing the state field to have its value updated.

Constructor Detail

UpdateItem

UpdateItem(AbstractExpression parent)

Creates a new UpdateItem.

Parameters:

parent - The parent of this expression

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.

addChildrenTo

void addChildrenTo(java.util.Collection<Expression> children)

Adds the children of this Expression to the given collection.

Overrides:

addChildrenTo in class AbstractExpression

Parameters:

children - The collection used to store the children

addOrderedChildrenTo

void addOrderedChildrenTo(java.util.List<StringExpression> children)

Adds the StringExpressions representing this Expression.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this 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()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

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

parse

void parse(WordParser wordParser,
           boolean tolerant)

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

void toParsedText(java.lang.StringBuilder writer,
                  boolean includeVirtual)

Generates a string representation of this Expression.

Specified by:

toParsedText in class AbstractExpression

Parameters:

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

includeVirtual - Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist