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

Class UpdateStatement

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.UpdateStatement
All Implemented Interfaces:
Expression
public final class UpdateStatement extends AbstractExpression
The UPDATE clause of a query consists of a conditional expression used to select objects or values that satisfy the expression. The UPDATE clause restricts the result of a select statement or the scope of an update operation.
BNF: update_statement ::= update_clause [where_clause]
Since:
2.3
Version:
2.5
See Also:

  • Constructor Details

    • UpdateStatement

      public UpdateStatement(AbstractExpression parent)
      Creates a new UpdateStatement.
      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

    • 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

    • getUpdateClause

      public UpdateClause getUpdateClause()
      Returns the UpdateClause representing the UPDATE clause.
      Returns:
      The section of the update statement representing the UPDATE clause

    • getWhereClause

      public Expression getWhereClause()
      Returns the Expression representing the WHERE clause.
      Returns:
      The section of the update statement representing the WHERE clause

    • hasSpaceAfterUpdateClause

      public boolean hasSpaceAfterUpdateClause()
      Determines whether a whitespace was parsed after the UPDATE clause.
      Returns:
      true if a whitespace was parsed after the UPDATE clause; false otherwise

    • hasWhereClause

      public boolean hasWhereClause()
      Determines whether the WHERE clause is defined or not.
      Returns:
      true if this statement has a WHERE clause; false if it was not 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