|
EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.UpdateClause
public final class UpdateClause
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.
update_clause ::= UPDATE abstract_schema_name [[AS] identification_variable] SET update_item {, update_item}*
UpdateStatement,
UpdateItem| 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 |
| Constructor Summary | |
|---|---|
UpdateClause(AbstractExpression parent)
Creates a new UpdateClause. |
|
| Method Summary | |
|---|---|
void |
accept(ExpressionVisitor visitor)
Visits this Expression by the given visitor. |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this Expression. |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list. |
CollectionExpression |
buildCollectionExpression()
Creates a new CollectionExpression that will wrap the single update item. |
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. |
protected boolean |
isParsingComplete(WordParser wordParser,
java.lang.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(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this Expression, including its children,
if it has any. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public UpdateClause(AbstractExpression parent)
UpdateClause.
parent - The parent of this expression| Method Detail |
|---|
public 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.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression to the given collection.
addChildrenTo in class AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression to the given list.
addOrderedChildrenTo in class AbstractExpressionchildren - The list used to store the string representation of this AbstractExpressionpublic CollectionExpression buildCollectionExpression()
CollectionExpression that will wrap the single update item.
public 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 parsedprotected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete in class AbstractExpressionwordParser - The text to parse based on the current position of the cursorword - The word that was retrieved from the given text, which is the first word in the textexpression - The Expression that has already been parsed
true if the text no longer can't be parsed by the current expression;
false if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser.
parse in class AbstractExpressionwordParser - The text to parse based on the current position of the cursortolerant - Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queries
protected void toParsedText(java.lang.StringBuilder writer,
boolean actual)
Expression, including its children,
if it has any.
toParsedText in class AbstractExpressionwriter - The buffer used to append this Expression's string representationactual - 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
|
EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||