|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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 | |
---|---|
private boolean |
hasSet Determines whether the identifier SET was parsed. |
private boolean |
hasSpaceAfterRangeVariableDeclaration Determines whether a whitespace was parsed after the abstract schema name declaration. |
private boolean |
hasSpaceAfterSet Determines whether a whitespace was parsed after SET. |
private boolean |
hasSpaceAfterUpdate Determines whether a whitespace was parsed after UPDATE. |
private AbstractExpression |
rangeVariableDeclaration The Expression representing the range variable declaration. |
private AbstractExpression |
updateItems The expression containing the update items. |
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 |
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 . |
(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 . |
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. |
(package private) 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. |
(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, 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 |
---|
private boolean hasSet
private boolean hasSpaceAfterRangeVariableDeclaration
private boolean hasSpaceAfterSet
private boolean hasSpaceAfterUpdate
private AbstractExpression rangeVariableDeclaration
Expression
representing the range variable declaration.private AbstractExpression updateItems
Constructor Detail |
---|
UpdateClause(AbstractExpression parent)
UpdateClause
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The visitor
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()
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.
visitor
- The visitor
to visit the children of this object.void addChildrenTo(java.util.Collection<Expression> children)
Expression
to the given collection.addChildrenTo
in class AbstractExpression
children
- The collection used to store the childrenvoid addOrderedChildrenTo(java.util.List<StringExpression> children)
StringExpressions
representing this Expression
.addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this Expression
public CollectionExpression buildCollectionExpression()
CollectionExpression
that will wrap the single update item.public JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public 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 parsedboolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
wordParser
- 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 parsedtrue
if the text no longer can't be parsed by the current expression; false
if more can be parsedvoid parse(WordParser wordParser, boolean tolerant)
WordParser
.parse
in class AbstractExpression
wordParser
- 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 queriesvoid toParsedText(java.lang.StringBuilder writer, boolean includeVirtual)
Expression
.toParsedText
in class AbstractExpression
writer
- The buffer used to append this Expression
's string representationincludeVirtual
- 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
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |