org.sql.generation.api.grammar.builders.query.QueryBuilder Maven / Gradle / Ivy

/*
 * Copyright (c) 2010, Stanislav Muhametsin. All Rights Reserved.
 *
 * 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 org.sql.generation.api.grammar.builders.query;

import org.sql.generation.api.grammar.builders.AbstractBuilder;
import org.sql.generation.api.grammar.common.SetQuantifier;
import org.sql.generation.api.grammar.query.CorrespondingSpec;
import org.sql.generation.api.grammar.query.QueryExpressionBody;
import org.sql.generation.api.grammar.query.QuerySpecification;

/**
 * The builder that builds the SQL queries having {@code UNION}, {@code INTERSECT}, or {@code EXCEPT} between the
 * {@code SELECT} statements.
 * 
 * @author Stanislav Muhametsin
 * @see QueryExpressionBody
 * @see QuerySpecification
 * @see QuerySpecificationBuilder
 * @see CorrespondingSpec
 */
public interface QueryBuilder
    extends AbstractBuilder
{
    /**
     * 
     * Adds {@code UNION} between current query and the given query. Then makes resulting query the current query.
     * 
     * 
     * This is equivalent on calling {@link #union(SetQuantifier, QueryExpressionBody)} and giving
     * {@link SetQuantifier#DISTINCT} as first parameter.
     * 
     * 
     * @param another The query to perform {@code UNION} with.
     * @return This builder.
     */
    public QueryBuilder union( QueryExpressionBody another );

    /**
     * 
     * Adds {@code UNION } between current query and the given query. Then makes resulting query the
     * current query.
     * 
     * 
     * This is equivalent on calling {@link #union(SetQuantifier, CorrespondingSpec, QueryExpressionBody)} and giving
     * {@code null} as second parameter.
     * 
     * 
     * @param setQuantifier The set quantifier for this union.
     * @param another The query to perform {@code UNION} with.
     * @return This builder.
     */
    public QueryBuilder union( SetQuantifier setQuantifier, QueryExpressionBody another );

    /**
     * 
     * Adds {@code UNION } between current query and the given query. Then makes resulting query the
     * current query.
     * 
     * 
     * This is equivalent on calling {@link #union(SetQuantifier, CorrespondingSpec, QueryExpressionBody)} and giving
     * {@link SetQuantifier#DISTINCT} as first parameter.
     * 
     * 
     * @param correspondingSpec The column correspondence specification.
     * @param another The query to perform {@code UNION} with.
     * @return This builder.
     */
    public QueryBuilder union( CorrespondingSpec correspondingSpec, QueryExpressionBody another );

    /**
     * Adds {@code UNION  } between current query and the given query. Then makes
     * resulting query the current query.
     * 
     * @param setQuantifier The set quantifier for this union.
     * @param correspondingSpec The column correspondence specification. May be {@code null}.
     * @param another The query to perform {@code UNION} with.
     * @return This builder.
     */
    public QueryBuilder union( SetQuantifier setQuantifier, CorrespondingSpec correspondingSpec,
        QueryExpressionBody another );

    /**
     * 
     * Adds {@code INTERSECT} between current query and the given query. Then makes resulting query the current query.
     * 
     * 
     * This is equivalent on calling {@link #intersect(SetQuantifier, QueryExpressionBody)} and giving
     * {@link SetQuantifier#DISTINCT} as first parameter.
     * 
     * 
     * @param another The query to perform {@code INTERSECT} with.
     * @return This builder.
     */
    public QueryBuilder intersect( QueryExpressionBody another );

    /**
     * 
     * Adds {@code INTERSECT } between current query and the given query. Then makes resulting query the
     * current query.
     * 
     * 
     * This is equivalent on calling {@link #intersect(SetQuantifier, CorrespondingSpec, QueryExpressionBody)} and
     * giving {@code null} as second parameter.
     * 
     * 
     * @param setQuantifier The set quantifier for this union.
     * @param another The query to perform {@code INTERSECT} with.
     * @return This builder.
     */
    public QueryBuilder intersect( SetQuantifier setQuantifier, QueryExpressionBody another );

    /**
     * 
     * Adds {@code INTERSECT } between current query and the given query. Then makes resulting query
     * the current query.
     * 
     * 
     * This is equivalent on calling {@link #intersect(SetQuantifier, CorrespondingSpec, QueryExpressionBody)} and
     * giving {@link SetQuantifier#DISTINCT} as first parameter.
     * 
     * 
     * @param correspondingSpec The column correspondence specification.
     * @param another The query to perform {@code INTERSECT} with.
     * @return This builder.
     */
    public QueryBuilder intersect( CorrespondingSpec correspondingSpec, QueryExpressionBody another );

    /**
     * Adds {@code INTERSECT  } between current query and the given query. Then makes
     * resulting query the current query.
     * 
     * @param setQuantifier The set quantifier for this union.
     * @param correspondingSpec The column correspondence specification. May be {@code null}.
     * @param another The query to perform {@code INTERSECT} with.
     * @return This builder.
     */
    public QueryBuilder intersect( SetQuantifier setQuantifier, CorrespondingSpec correspondingSpec,
        QueryExpressionBody another );

    /**
     * 
     * Adds {@code EXCEPT} between current query and the given query. Then makes resulting query the current query.
     * 
     * 
     * This is equivalent on calling {@link #except(SetQuantifier, QueryExpressionBody)} and giving
     * {@link SetQuantifier#DISTINCT} as first parameter.
     * 
     * 
     * @param another The query to perform {@code EXCEPT} with.
     * @return This builder.
     */
    public QueryBuilder except( SetQuantifier setQuantifier, CorrespondingSpec correspondingSpec,
        QueryExpressionBody another );

    /**
     * 
     * Adds {@code EXCEPT } between current query and the given query. Then makes resulting query the
     * current query.
     * 
     * 
     * This is equivalent on calling {@link #except(SetQuantifier, CorrespondingSpec, QueryExpressionBody)} and giving
     * {@code null} as second parameter.
     * 
     * 
     * @param setQuantifier The set quantifier for this union.
     * @param another The query to perform {@code EXCEPT} with.
     * @return This builder.
     */
    public QueryBuilder except( QueryExpressionBody another );

    /**
     * 
     * Adds {@code EXCEPT } between current query and the given query. Then makes resulting query the
     * current query.
     * 
     * 
     * This is equivalent on calling {@link #except(SetQuantifier, CorrespondingSpec, QueryExpressionBody)} and giving
     * {@link SetQuantifier#DISTINCT} as first parameter.
     * 
     * 
     * @param correspondingSpec The column correspondence specification.
     * @param another The query to perform {@code EXCEPT} with.
     * @return This builder.
     */
    public QueryBuilder except( SetQuantifier setQuantifier, QueryExpressionBody another );

    /**
     * Adds {@code EXCEPT  } between current query and the given query. Then makes
     * resulting query the current query.
     * 
     * @param setQuantifier The set quantifier for this union.
     * @param correspondingSpec The column correspondence specification. May be {@code null}.
     * @param another The query to perform {@code EXCEPT} with.
     * @return This builder.
     */
    public QueryBuilder except( CorrespondingSpec correspondingSpec, QueryExpressionBody another );
}