org.ibatis.persist.criteria.CriteriaUpdate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbatis Show documentation

The jBATIS persistence framework will help you to significantly reduce the amount of Java code that you normally need to access a relational database. iBATIS simply maps JavaBeans to SQL statements using a very simple XML descriptor.

The newest version!

package org.ibatis.persist.criteria;

/**
 * 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 synchronized with
 * the result of the bulk update.
 *
 * 
 * A CriteriaUpdate object must have a single root.
 *
 * @param 
 *            the entity type that is the target of the update
 *
 * @since iBatis Persistence 1.0
 */
public interface CriteriaUpdate extends CommonAbstractCriteria, Parameterized> {

    /**
     * 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.
     * 
     * @param entityClass
     *            the entity class
     * @return query root corresponding to the given entity
     */
    Root from(Class entityClass);

    /**
     * Return the query root.
     * 
     * @return the query root
     */
    Root getRoot();

    /**
     * Update the value of the specified attribute.
     * 
     * @param attribute
     *            attribute to be updated
     * @param value
     *            new value
     * @return the modified update query
     */
     CriteriaUpdate set(Path attribute, X value);

    /**
     * Update the value of the specified attribute.
     * 
     * @param attribute
     *            attribute to be updated
     * @param value
     *            new value
     * @return the modified update query
     */
     CriteriaUpdate set(Path attribute, Expression value);

    /**
     * Update the value of the specified attribute.
     * 
     * @param attribute
     *            the attribute to be updated
     * @param value
     *            new value
     * @return the modified update query
     */
     CriteriaUpdate set(Y attribute, Expression value);

    /**
     * Update the value of the specified attribute.
     * 
     * @param attribute
     *            the attribute to be updated
     * @param value
     *            new value
     * @return the modified update query
     */
     CriteriaUpdate set(Y attribute, Y value);

    /**
     * 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.
     * 
     * @param restriction
     *            a simple or compound boolean expression
     * @return the modified update query
     */
    CriteriaUpdate where(Expression restriction);

    /**
     * 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.
     * 
     * @param restrictions
     *            zero or more restriction predicates
     * @return the modified update query
     */
    CriteriaUpdate where(Predicate... restrictions);
}