com.blazebit.persistence.BaseUpdateCriteriaBuilder Maven / Gradle / Ivy

/*
 * Copyright 2014 - 2020 Blazebit.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.blazebit.persistence;

/**
 * A builder for update queries.
 *
 * @param  The entity type for which this update query is
 * @param  The concrete builder type
 * @author Christian Beikov
 * @since 1.1.0
 */
public interface BaseUpdateCriteriaBuilder> extends BaseModificationCriteriaBuilder {

    /**
     * Binds the given value as parameter to the attribute.
     *
     * @param attribute The attribute for which the value should be bound
     * @param value The value that should be bound
     * @return The query builder for chaining calls
     */
    public X set(String attribute, Object value);

    /**
     * Binds NULL to the attribute.
     *
     * @param attribute The attribute for which NULL should be bound
     * @return The query builder for chaining calls
     * @since 1.5.0
     */
    public X setNull(String attribute);

    /**
     * Binds the given expression to the attribute.
     *
     * @param attribute The attribute for which the expression should be bound
     * @param expression The expression that should be bound
     * @return The query builder for chaining calls
     */
    public X setExpression(String attribute, String expression);

    /**
     * Starts a subquery builder for creating an expression that should be bound to the attribute.
     *
     * @param attribute The attribute for which the subquery expression should be bound
     * @return The query builder for chaining calls
     */
    public SubqueryInitiator set(String attribute);

    /**
     * Starts a subquery builder for creating an expression that should be bound to the attribute based on the given criteria builder.
     *
     * @param attribute The attribute for which the subquery expression should be bound
     * @param criteriaBuilder The criteria builder to base the subquery on
     * @return The subquery builder for building a subquery
     * @since 1.2.0
     */
    public SubqueryBuilder set(String attribute, FullQueryBuilder criteriaBuilder);

    /**
     * Starts a {@link MultipleSubqueryInitiator} with the given expression that should bound to the attribute.
     *
     * 
     * All occurrences of subsequently defined subqueryAliases in expression will be replaced by the respective subquery.
     * When the builder finishes, the predicate is added to the parent predicate container represented by the type T.
     * 
     *
     * @param attribute The attribute for which the expression should be bound
     * @param expression The expression for the lower bound of the between predicate.
     * @return The subquery initiator for building multiple subqueries for their respective subqueryAliases
     */
    public MultipleSubqueryInitiator setSubqueries(String attribute, String expression);
    
}