org.eclipse.persistence.jpa.jpql.tools.model.query

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

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]

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 and Description
UpdateStatementStateObject(JPQLQueryStateObject parent) Creates a new UpdateStatementStateObject.

Method Summary

Modifier and Type	Method and Description
void	accept(StateObjectVisitor visitor) Visits this StateObject by the given visitor.
UpdateItemStateObject	addItem(java.lang.String path) Adds a new item to the UPDATE clause.
UpdateItemStateObject	addItem(java.lang.String path, StateObject newValue) Adds a new item to the UPDATE clause.
UpdateItemStateObject	addItem(java.lang.String path, java.lang.String newValue) Adds a new item to the UPDATE clause.
protected AbstractModifyClauseStateObject	buildModifyClause() Creates the actual AbstractModifyClauseStateObject that represents the modify clause.
UpdateStatement	getExpression() Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
UpdateClauseStateObject	getModifyClause() Returns the state object representing the UPDATE clause.
void	setExpression(UpdateStatement expression) Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateStatementStateObject

public UpdateStatementStateObject(JPQLQueryStateObject parent)

Creates a new UpdateStatementStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

java.lang.NullPointerException - The given parent cannot be null

Method Detail

accept

public void accept(StateObjectVisitor visitor)

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

addItem

public UpdateItemStateObject addItem(java.lang.String path)

Adds a new item to the UPDATE clause.

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 the UPDATE clause.

Parameters:

path - The path of the value to update

newValue - The StateObject representation 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 the UPDATE clause.

Parameters:

path - The path of the value to update

newValue - The string representation of the new value to parse and to convert into a StateObject representation

Returns:

The newly added UpdateItemStateObject

buildModifyClause

protected AbstractModifyClauseStateObject buildModifyClause()

Creates the actual AbstractModifyClauseStateObject that represents the modify clause.

Specified by:

buildModifyClause in class AbstractModifyStatementStateObject

Returns:

The modify clause part of this modify statement

getExpression

public UpdateStatement getExpression()

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Specified by:

getExpression in interface StateObject

Overrides:

getExpression in class AbstractStateObject

Returns:

The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

getModifyClause

public UpdateClauseStateObject getModifyClause()

Returns the state object representing the UPDATE clause.

Overrides:

getModifyClause in class AbstractModifyStatementStateObject

Returns:

The state object representing the UPDATE clause, which is never null

setExpression

public void setExpression(UpdateStatement expression)

Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Parameters:

expression - The parsed object representing an UpdateStatement statement