Class UpdateStatementStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.UpdateStatementStateObject
-
- All Implemented Interfaces:
StateObject
public class UpdateStatementStateObject extends AbstractModifyStatementStateObject
TheUPDATEclause of a query consists of a conditional expression used to select objects or values that satisfy the expression. TheUPDATEclause restricts the result of a select statement or the scope of an update operation.BNF:update_statement ::= update_clause [where_clause]- Version:
- 2.4
- See Also:
UpdateStatement- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject
WHERE_CLAUSE_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description UpdateStatementStateObject(JPQLQueryStateObject parent)Creates a newUpdateStatementStateObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StateObjectVisitor visitor)Visits thisStateObjectby the givenvisitor.UpdateItemStateObjectaddItem(java.lang.String path)Adds a new item to theUPDATEclause.UpdateItemStateObjectaddItem(java.lang.String path, java.lang.String newValue)Adds a new item to theUPDATEclause.UpdateItemStateObjectaddItem(java.lang.String path, StateObject newValue)Adds a new item to theUPDATEclause.protected AbstractModifyClauseStateObjectbuildModifyClause()Creates the actualAbstractModifyClauseStateObjectthat represents the modify clause.UpdateStatementgetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.UpdateClauseStateObjectgetModifyClause()Returns the state object representing theUPDATEclause.voidsetExpression(UpdateStatement expression)Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject
addChildren, addWhereClause, getAbstractSchemaName, getAbstractSchemaNameStateObject, getDeclaration, getEntity, getIdentificationVariable, getIdentificationVariableStateObject, getParent, getRangeVariableDeclaration, getWhereClause, hasWhereClause, initialize, isEquivalent, removeWhereClause, setConditionalStateObject, setDeclaration, setDeclaration, setDeclaration, setDeclaration, setEntity, setEntityName, setIdentificationVariable, toggleWhereClause, toTextInternal
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText
-
-
-
-
Constructor Detail
-
UpdateStatementStateObject
public UpdateStatementStateObject(JPQLQueryStateObject parent)
Creates a newUpdateStatementStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObjectby the givenvisitor.- Parameters:
visitor- Thevisitorto visit this object
-
addItem
public UpdateItemStateObject addItem(java.lang.String path)
Adds a new item to theUPDATEclause.- Parameters:
path- The path of the value to update- Returns:
- The newly added
UpdateItemStateObject
-
addItem
public UpdateItemStateObject addItem(java.lang.String path, StateObject newValue)
Adds a new item to theUPDATEclause.- Parameters:
path- The path of the value to updatenewValue- TheStateObjectrepresentation of the new value- Returns:
- The newly added
UpdateItemStateObject
-
addItem
public UpdateItemStateObject addItem(java.lang.String path, java.lang.String newValue)
Adds a new item to theUPDATEclause.- Parameters:
path- The path of the value to updatenewValue- The string representation of the new value to parse and to convert into aStateObjectrepresentation- Returns:
- The newly added
UpdateItemStateObject
-
buildModifyClause
protected AbstractModifyClauseStateObject buildModifyClause()
Creates the actualAbstractModifyClauseStateObjectthat represents the modify clause.- Specified by:
buildModifyClausein classAbstractModifyStatementStateObject- Returns:
- The modify clause part of this modify statement
-
getExpression
public UpdateStatement getExpression()
Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpressionin interfaceStateObject- Overrides:
getExpressionin classAbstractStateObject- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObjectornullwhen the JPQL query is manually created (i.e. not from a string)
-
getModifyClause
public UpdateClauseStateObject getModifyClause()
Returns the state object representing theUPDATEclause.- Overrides:
getModifyClausein classAbstractModifyStatementStateObject- Returns:
- The state object representing the
UPDATEclause, which is nevernull
-
setExpression
public void setExpression(UpdateStatement expression)
Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.- Parameters:
expression- Theparsed objectrepresenting anUpdateStatementstatement
-
-