Package org.hibernate.query.sqm.tree.update

Class SqmUpdateStatement<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.AbstractSqmStatement<E>

org.hibernate.query.sqm.tree.AbstractSqmDmlStatement<T>

org.hibernate.query.sqm.tree.AbstractSqmRestrictedDmlStatement<T>

org.hibernate.query.sqm.tree.update.SqmUpdateStatement<T>

All Implemented Interfaces:

CommonAbstractCriteria, CriteriaUpdate<T>, Serializable, JpaCriteriaBase, JpaCriteriaNode, JpaCriteriaUpdate<T>, JpaCteContainer, JpaManipulationCriteria<T>, JpaQueryableCriteria<T>, ParameterCollector, SqmCteContainer, SqmWhereClauseContainer, SqmDeleteOrUpdateStatement<T>, SqmDmlStatement<T>, SqmNode, SqmQuery<T>, SqmStatement<T>, SqmVisitableNode

public class SqmUpdateStatement<T>
extends AbstractSqmRestrictedDmlStatement<T>
implements SqmDeleteOrUpdateStatement<T>, JpaCriteriaUpdate<T>

Author:

Steve Ebersole

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.sqm.tree.SqmStatement

SqmStatement.ParameterResolutions

Field Summary

Fields inherited from interface org.hibernate.query.sqm.tree.SqmNode

log

Constructor Summary

Constructors

Constructor	Description
SqmUpdateStatement(Class<T> targetEntity, SqmCriteriaNodeBuilder nodeBuilder)
SqmUpdateStatement(NodeBuilder nodeBuilder)
SqmUpdateStatement(NodeBuilder builder, SqmQuerySource querySource, Set<SqmParameter<?>> parameters, Map<String,SqmCteStatement<?>> cteStatements, SqmRoot<T> target)
SqmUpdateStatement(SqmRoot<T> target, NodeBuilder nodeBuilder)	Deprecated, for removal: This API element is subject to removal in a future version. was previously used for HQL.
SqmUpdateStatement(SqmRoot<T> target, SqmQuerySource querySource, NodeBuilder nodeBuilder)	Deprecated, for removal: This API element is subject to removal in a future version. was previously used for Criteria.

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	appendHqlString(StringBuilder sb)
<Y> void	applyAssignment(SqmPath<Y> targetPath, SqmExpression<? extends Y> value)
<Y> void	applyAssignment(SqmAssignment<Y> assignment)
SqmUpdateStatement<T>	copy(SqmCopyContext context)
SqmSetClause	getSetClause()
boolean	isVersioned()
<Y> SqmUpdateStatement<T>	set(Path<Y> attribute, Expression<? extends Y> value)	Update the value of the specified attribute.
<Y, X extends Y> SqmUpdateStatement<T>	set(Path<Y> attribute, X value)	Update the value of the specified attribute.
<Y> SqmUpdateStatement<T>	set(SingularAttribute<? super T,Y> attribute, Expression<? extends Y> value)	Update the value of the specified attribute.
<Y, X extends Y> SqmUpdateStatement<T>	set(SingularAttribute<? super T,Y> attribute, X value)	Update the value of the specified attribute.
SqmUpdateStatement<T>	set(String attributeName, Object value)	Update the value of the specified attribute.
void	setSetClause(SqmSetClause setClause)
void	setTarget(JpaRoot<T> root)	Set the root path
void	validate(@Nullable String hql)
SqmUpdateStatement<T>	versioned()
SqmUpdateStatement<T>	versioned(boolean versioned)
SqmUpdateStatement<T>	where(Expression<Boolean> restriction)	Modify the update query to restrict the target of the update according to the specified boolean expression.
SqmUpdateStatement<T>	where(Predicate... restrictions)	Modify the update query to restrict the target of the update according to the conjunction of the specified restriction predicates.

Methods inherited from class org.hibernate.query.sqm.tree.AbstractSqmRestrictedDmlStatement

applyPredicate, copyWhereClause, from, from, getRestriction, getRoot, getWhereClause, initAndGetWhereClause, setWhere, setWhere, setWhereClause

Methods inherited from class org.hibernate.query.sqm.tree.AbstractSqmDmlStatement

appendHqlCteString, copyCteStatements, getCteCriteria, getCteCriterias, getCteStatement, getCteStatements, getTarget, putAllCtes, subquery, with, with, withRecursiveUnionAll, withRecursiveUnionAll, withRecursiveUnionDistinct, withRecursiveUnionDistinct

Methods inherited from class org.hibernate.query.sqm.tree.AbstractSqmStatement

addParameter, copyParameters, getQuerySource, getSqmParameters, resolveParameters

Methods inherited from class org.hibernate.query.sqm.tree.AbstractSqmNode

nodeBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.query.criteria.JpaCriteriaBase

getRestriction, subquery

Methods inherited from interface org.hibernate.query.criteria.JpaCriteriaUpdate

from, from, getRoot

Methods inherited from interface org.hibernate.query.criteria.JpaCteContainer

getCteCriteria, getCteCriterias, with, with, withRecursiveUnionAll, withRecursiveUnionAll, withRecursiveUnionDistinct, withRecursiveUnionDistinct

Methods inherited from interface org.hibernate.query.sqm.tree.cte.SqmCteContainer

getCteStatement, getCteStatements

Methods inherited from interface org.hibernate.query.sqm.tree.SqmDmlStatement

getTarget

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.SqmStatement

getQuerySource, getSqmParameters, resolveParameters

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode

toHqlString

Methods inherited from interface org.hibernate.query.sqm.tree.predicate.SqmWhereClauseContainer

applyPredicate, getWhereClause

Constructor Details

SqmUpdateStatement

public SqmUpdateStatement(NodeBuilder nodeBuilder)

SqmUpdateStatement

@Deprecated(forRemoval=true)
public SqmUpdateStatement(SqmRoot<T> target,
 NodeBuilder nodeBuilder)

Deprecated, for removal: This API element is subject to removal in a future version.

was previously used for HQL. Use SqmUpdateStatement(NodeBuilder) instead

SqmUpdateStatement

@Deprecated(forRemoval=true)
public SqmUpdateStatement(SqmRoot<T> target,
 SqmQuerySource querySource,
 NodeBuilder nodeBuilder)

Deprecated, for removal: This API element is subject to removal in a future version.

was previously used for Criteria. Use SqmUpdateStatement(Class, SqmCriteriaNodeBuilder) instead.

SqmUpdateStatement

public SqmUpdateStatement(Class<T> targetEntity,
 SqmCriteriaNodeBuilder nodeBuilder)

SqmUpdateStatement

public SqmUpdateStatement(NodeBuilder builder,
 SqmQuerySource querySource,
 Set<SqmParameter<?>> parameters,
 Map<String,SqmCteStatement<?>> cteStatements,
 SqmRoot<T> target)

Method Details

copy

public SqmUpdateStatement<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmQuery<T>

Specified by:

copy in interface SqmStatement<T>

validate

public void validate(@Nullable String hql)

Specified by:

validate in class AbstractSqmDmlStatement<T>

getSetClause

public SqmSetClause getSetClause()

setSetClause

public void setSetClause(SqmSetClause setClause)

set

public <Y,
X extends Y> SqmUpdateStatement<T> set(SingularAttribute<? super T,Y> attribute,
 X value)

Description copied from interface: CriteriaUpdate

Update the value of the specified attribute.

Specified by:

set in interface CriteriaUpdate<T>

Specified by:

set in interface JpaCriteriaUpdate<T>

Parameters:

attribute - attribute to be updated

value - new value

Returns:

the modified update query

set

public <Y> SqmUpdateStatement<T> set(SingularAttribute<? super T,Y> attribute,
 Expression<? extends Y> value)

Description copied from interface: CriteriaUpdate

Update the value of the specified attribute.

Specified by:

set in interface CriteriaUpdate<T>

Specified by:

set in interface JpaCriteriaUpdate<T>

Parameters:

attribute - attribute to be updated

value - new value

Returns:

the modified update query

set

public <Y,
X extends Y> SqmUpdateStatement<T> set(Path<Y> attribute,
 X value)

Description copied from interface: CriteriaUpdate

Update the value of the specified attribute.

Specified by:

set in interface CriteriaUpdate<T>

Specified by:

set in interface JpaCriteriaUpdate<T>

Parameters:

attribute - attribute to be updated

value - new value

Returns:

the modified update query

set

public <Y> SqmUpdateStatement<T> set(Path<Y> attribute,
 Expression<? extends Y> value)

Description copied from interface: CriteriaUpdate

Update the value of the specified attribute.

Specified by:

set in interface CriteriaUpdate<T>

Specified by:

set in interface JpaCriteriaUpdate<T>

Parameters:

attribute - attribute to be updated

value - new value

Returns:

the modified update query

set

public SqmUpdateStatement<T> set(String attributeName,
 Object value)

Description copied from interface: CriteriaUpdate

Update the value of the specified attribute.

Specified by:

set in interface CriteriaUpdate<T>

Specified by:

set in interface JpaCriteriaUpdate<T>

Parameters:

attributeName - name of the attribute to be updated

value - new value

Returns:

the modified update query

isVersioned

public boolean isVersioned()

Specified by:

isVersioned in interface JpaCriteriaUpdate<T>

versioned

public SqmUpdateStatement<T> versioned()

Specified by:

versioned in interface JpaCriteriaUpdate<T>

versioned

public SqmUpdateStatement<T> versioned(boolean versioned)

Specified by:

versioned in interface JpaCriteriaUpdate<T>

setTarget

public void setTarget(JpaRoot<T> root)

Description copied from interface: SqmDmlStatement

Set the root path

Specified by:

setTarget in interface JpaManipulationCriteria<T>

Specified by:

setTarget in interface SqmDmlStatement<T>

Overrides:

setTarget in class AbstractSqmDmlStatement<T>

where

public SqmUpdateStatement<T> where(Expression<Boolean> restriction)

Description copied from interface: CriteriaUpdate

Modify the update query to restrict the target of the update according to the specified boolean expression. Replaces the previously added restriction(s), if any.

Specified by:

where in interface CriteriaUpdate<T>

Specified by:

where in interface JpaCriteriaUpdate<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified update query

where

public SqmUpdateStatement<T> where(Predicate... restrictions)

Description copied from interface: CriteriaUpdate

Modify the update query to restrict the target of the update according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.

Specified by:

where in interface CriteriaUpdate<T>

Specified by:

where in interface JpaCriteriaUpdate<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified update query

accept

public <X> X accept(SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

applyAssignment

public <Y> void applyAssignment(SqmPath<Y> targetPath,
 SqmExpression<? extends Y> value)

applyAssignment

public <Y> void applyAssignment(SqmAssignment<Y> assignment)

appendHqlString

public void appendHqlString(StringBuilder sb)

Specified by:

appendHqlString in interface SqmVisitableNode

Overrides:

appendHqlString in class AbstractSqmRestrictedDmlStatement<T>