JPA Interface

CriteriaUpdate

Type Parameters:
<T> - the entity type that is the target of the update
Super Interfaces:
CommonAbstractCriteria
The CriteriaUpdate interface defines functionality for performing bulk update operations using the Criteria API.

Criteria API bulk update operations map directly to database update operations, bypassing any optimistic locking checks. Portable applications using bulk update operations must manually update the value of the version column, if desired, and/or manually validate the value of the version column. The persistence context is not automatically synchronized with the result of the bulk update.

A CriteriaUpdate object must have a single root.

Since:
JPA 2.1

Public Methods

Root<T> from(Class<T> entityClass)
Create and add a query root corresponding to the entity that is the target of the update.
A CriteriaUpdate object has a single root, the entity that is being updated.
Parameters:
entityClass - the entity class
Return:
query root corresponding to the given entity
Since:
JPA 2.1
Root<T> from(EntityType<T> entity)
Create and add a query root corresponding to the entity that is the target of the update.
A CriteriaUpdate object has a single root, the entity that is being updated.
Parameters:
entity - metamodel entity representing the entity of type X
Return:
query root corresponding to the given entity
Since:
JPA 2.1
Set<ParameterExpression<?>> getParameters()
Return the parameters of the query.
Returns empty set if there are no parameters. Modifications to the set do not affect the query.
Return:
the query parameters
Inherited from:
CommonAbstractCriteria
Since:
JPA 2.1
Predicate getRestriction()
Return the predicate that corresponds to the where clause restriction(s), or null if no restrictions have been specified.
Return:
where clause predicate
Inherited from:
CommonAbstractCriteria
Since:
JPA 2.1
Root<T> getRoot()
Return the query root.
Return:
the query root
Since:
JPA 2.1
CriteriaUpdate<T> set(Path<Y> attribute, Expression<?extendsY> value)
Update the value of the specified attribute.
Parameters:
attribute - attribute to be updated
value - new value
Return:
the modified update query
Since:
JPA 2.1
CriteriaUpdate<T> set(Path<Y> attribute, X value)
Update the value of the specified attribute.
Parameters:
attribute - attribute to be updated
value - new value
Return:
the modified update query
Since:
JPA 2.1
CriteriaUpdate<T> set(SingularAttribute<?superT,Y> attribute, Expression<?extendsY> value)
Update the value of the specified attribute.
Parameters:
attribute - attribute to be updated
value - new value
Return:
the modified update query
Since:
JPA 2.1
CriteriaUpdate<T> set(SingularAttribute<?superT,Y> attribute, X value)
Update the value of the specified attribute.
Parameters:
attribute - attribute to be updated
value - new value
Return:
the modified update query
Since:
JPA 2.1
CriteriaUpdate<T> set(String attributeName, Object value)
Update the value of the specified attribute.
Parameters:
attributeName - name of the attribute to be updated
value - new value
Return:
the modified update query
Since:
JPA 2.1
Subquery<U> subquery(Class<U> type)
Create a subquery of the query.
Parameters:
type - the subquery result type
Return:
subquery
Inherited from:
CommonAbstractCriteria
Since:
JPA 2.1
Subquery<U> subquery(EntityType<U> type)
Create a subquery of the query.
Parameters:
type - the subquery result type
Return:
subquery
Inherited from:
CommonAbstractCriteria
Since:
JPA 2.1
CriteriaUpdate<T> where(Expression<Boolean> restriction)
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.
Parameters:
restriction - a simple or compound boolean expression
Return:
the modified update query
Since:
JPA 2.1
CriteriaUpdate<T> where(Predicate... restrictions)
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.
Parameters:
restrictions - zero or more restriction predicates
Return:
the modified update query
Since:
JPA 2.1