Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.parser

public final Class UpdateItem

extends AbstractExpression
Class Inheritance
Imports
java.util.Collection, .List, org.eclipse.persistence.jpa.jpql.WordParser
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
Author
Pascal Filion
Since
2.3
Version
2.5
See Also
UpdateClause

Field Summary

Modifier and TypeField and Description
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.

Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
COMMADOTDOUBLE_QUOTELEFT_CURLY_BRACKETLEFT_PARENTHESISNOT_DEFINEDRIGHT_CURLY_BRACKETRIGHT_PARENTHESISSINGLE_QUOTESPACEUNDERSCORE

Constructor Summary

AccessConstructor and Description
public
UpdateItem(AbstractExpression
The parent of this expression
parent)

Creates a new UpdateItem.

Method Summary

Modifier and TypeMethod and Description
public void
accept(ExpressionVisitor
The ExpressionVisitor to visit this object
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.
public void
acceptChildren(ExpressionVisitor
The visitor to visit the children of this object.
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression.
protected void
addChildrenTo(Collection<Expression>
The collection used to store the children
children)

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

Adds the children of this AbstractExpression to the given collection.
protected void
addOrderedChildrenTo(List<Expression>
The list used to store the string representation of this AbstractExpression
children)

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

Adds the children of this AbstractExpression to the given list.
public JPQLQueryBNF
findQueryBNF(Expression
The Expression that is a descendant of this one
expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

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

Returns:

The expression for the new value
getNewValue()

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

public JPQLQueryBNF
getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.
public Expression

Returns:

The expression for the state field path expression
getStateFieldPathExpression()

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

public boolean

Returns:

true if the equal sign was parsed; false otherwise
hasEqualSign()

Determines whether the equal sign was parsed or not.

public boolean

Returns:

true the new value was parsed; false if nothing was parsed
hasNewValue()

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

public boolean

Returns:

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

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

public boolean

Returns:

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

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

public boolean

Returns:

true the state field was parsed; false otherwise
hasStateFieldPathExpression()

Determines whether the state field was parsed.

protected boolean
isParsingComplete(WordParser
The text to parse based on the current position of the cursor
wordParser, String
The word that was retrieved from the given text, which is the first word in the text
word, Expression
The Expression that has already been parsed
expression)

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

Determines whether the parsing is complete based on what is left in the given text.
protected void
parse(WordParser
The text to parse based on the current position of the cursor
wordParser, boolean
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.
protected void
toParsedText(StringBuilder
The buffer used to append this Expression's string representation
writer, boolean
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
actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
acceptUnknownVisitoracceptUnknownVisitorbuildExpressionFromFallingBackbuildNullExpressionbuildStringExpressionbuildStringExpressionbuildUnknownExpressioncalculatePositionchildrenfindFallBackExpressionFactorygetExpressionFactorygetExpressionRegistrygetGrammargetIdentifierVersiongetJPAVersiongetLengthgetOffsetgetParentgetQueryBNFgetRootgetTexthandleAggregatehandleCollectionisAncestorisIdentifierisNullisTolerantisUnknownisVirtualorderedChildrenparseparseUsingExpressionFactorypopulatePositionrebuildActualTextrebuildParsedTextsetParentsetTextshouldParseWithFactoryFirstshouldSkipLiteraltoActualTexttoParsedTexttoString

Field Detail

hasEqualSignback to summary
private boolean hasEqualSign

Determines whether the equal sign was parsed or not.

hasSpaceAfterEqualSignback to summary
private boolean hasSpaceAfterEqualSign

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

hasSpaceAfterStateFieldPathExpressionback to summary
private boolean hasSpaceAfterStateFieldPathExpression

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

newValueback to summary
private AbstractExpression newValue

The expression representing the new value.

stateFieldExpressionback to summary
private AbstractExpression stateFieldExpression

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

Constructor Detail

UpdateItemback to summary
public UpdateItem(AbstractExpression parent)

Creates a new UpdateItem.

Parameters
parent:AbstractExpression

The parent of this expression

Method Detail

acceptback to summary
public void accept(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.

Parameters
visitor:ExpressionVisitor

The ExpressionVisitor to visit this object

Annotations
@Override
acceptChildrenback to summary
public void acceptChildren(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

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 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:ExpressionVisitor

The visitor to visit the children of this object.

Annotations
@Override
addChildrenToback to summary
protected void addChildrenTo(Collection<Expression> children)

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

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.

Parameters
children:Collection<Expression>

The collection used to store the children

Annotations
@Override
addOrderedChildrenToback to summary
protected void addOrderedChildrenTo(List<Expression> children)

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

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.

Parameters
children:List<Expression>

The list used to store the string representation of this AbstractExpression

Annotations
@Override
findQueryBNFback to summary
public JPQLQueryBNF findQueryBNF(Expression expression)

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

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

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

Parameters
expression:Expression

The Expression that is a descendant of this one

Returns:JPQLQueryBNF

The JPQLQueryBNF that was used to parse the given expression

Annotations
@Override
getNewValueback to summary
public Expression getNewValue()

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

Returns:Expression

The expression for the new value

getQueryBNFback to summary
public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations
@Override
getStateFieldPathExpressionback to summary
public Expression getStateFieldPathExpression()

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

Returns:Expression

The expression for the state field path expression

hasEqualSignback to summary
public boolean hasEqualSign()

Determines whether the equal sign was parsed or not.

Returns:boolean

true if the equal sign was parsed; false otherwise

hasNewValueback to summary
public boolean hasNewValue()

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

Returns:boolean

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

hasSpaceAfterEqualSignback to summary
public boolean hasSpaceAfterEqualSign()

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

Returns:boolean

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

hasSpaceAfterStateFieldPathExpressionback to summary
public boolean hasSpaceAfterStateFieldPathExpression()

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

Returns:boolean

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

hasStateFieldPathExpressionback to summary
public boolean hasStateFieldPathExpression()

Determines whether the state field was parsed.

Returns:boolean

true the state field was parsed; false otherwise

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

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

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.isParsingComplete.

Determines whether the parsing is complete based on what is left in the given text. The text is never empty.

Parameters
wordParser:WordParser

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

word:String

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

expression:Expression

The Expression that has already been parsed

Returns:boolean

true if the text no longer can't be parsed by the current expression; false if more can be parsed

Annotations
@Override
parseback to summary
protected void parse(WordParser wordParser, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

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

Parameters
wordParser:WordParser

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

tolerant:boolean

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

Annotations
@Override
toParsedTextback to summary
protected void toParsedText(StringBuilder writer, boolean actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

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

Parameters
writer:StringBuilder

The buffer used to append this Expression's string representation

actual:boolean

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

Annotations
@Override