org.jooq.WindowOverStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-plugin Show documentation
Kill Bill ADYEN SA plugin
There is a newer version: 0.10.0
/**
 * Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * This work is dual-licensed
 * - under the Apache Software License 2.0 (the "ASL")
 * - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
 * =============================================================================
 * You may choose which license applies to you:
 *
 * - If you're using this work with Open Source databases, you may choose
 *   either ASL or jOOQ License.
 * - If you're using this work with at least one commercial database, you must
 *   choose jOOQ License
 *
 * For more information, please visit http://www.jooq.org/licenses
 *
 * Apache Software License 2.0:
 * -----------------------------------------------------------------------------
 * 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.
 *
 * jOOQ License and Maintenance Agreement:
 * -----------------------------------------------------------------------------
 * Data Geekery grants the Customer the non-exclusive, timely limited and
 * non-transferable license to install and use the Software under the terms of
 * the jOOQ License and Maintenance Agreement.
 *
 * This library is distributed with a LIMITED WARRANTY. See the jOOQ License
 * and Maintenance Agreement for more details: http://www.jooq.org/licensing
 */
package org.jooq;

import static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.DERBY;
import static org.jooq.SQLDialect.H2;
import static org.jooq.SQLDialect.HSQLDB;
// ...
// ...
import static org.jooq.SQLDialect.POSTGRES;
// ...
// ...

/**
 * This type is used for the window function DSL API.
 * 
 * Example: 
 * field.firstValue()
 *      .ignoreNulls()
 *      .over()
 *      .partitionBy(AUTHOR_ID)
 *      .orderBy(PUBLISHED_IN.asc())
 *      .rowsBetweenUnboundedPreceding()
 *      .andUnboundedFollowing()
 * 
 * 
 * Unlike in {@link WindowBeforeOverStep}, OVER() is a mandatory
 * clause.
 *
 * @param  The function return type
 * @author Lukas Eder
 */
public interface WindowOverStep {

    /**
     * Turn this aggregate function into a window function.
     * 

     * An example: 
     * MAX(id) OVER (PARTITION BY 1)
     * 
     * 
     * Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL
     * Server and Sybase.
     */
    @Support({ CUBRID, DERBY, H2, HSQLDB, POSTGRES })
    WindowPartitionByStep over();

    /**
     * Turn this aggregate function into a window function referencing a window
     * name.
     * 

     * An example: 
     * MAX(id) OVER my_window
     * 
     * 
     * Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL
     * Server and Sybase. If the WINDOW clause is not supported
     * (see {@link SelectWindowStep#window(WindowDefinition...)}, then
     * referenced windows will be inlined.
     */
    @Support({ CUBRID, POSTGRES })
    WindowFinalStep over(Name name);

    /**
     * Turn this aggregate function into a window function referencing a window
     * name.
     * 

     * An example: 
     * MAX(id) OVER my_window
     * 
     * 
     * Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL
     * Server and Sybase. If the WINDOW clause is not supported
     * (see {@link SelectWindowStep#window(WindowDefinition...)}, then
     * referenced windows will be inlined.
     */
    @Support({ CUBRID, POSTGRES })
    WindowFinalStep over(String name);

    /**
     * Turn this aggregate function into a window function.
     * 

     * An example: 
     * MAX(id) OVER (PARTITION BY 1)
     * 
     * 
     * Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL
     * Server and Sybase.
     */
    @Support({ CUBRID, POSTGRES })
    WindowFinalStep over(WindowSpecification specification);

    /**
     * Turn this aggregate function into a window function referencing a window
     * definition.
     * 

     * An example: 
     * MAX(id) OVER my_window
     * 
     * 
     * Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL
     * Server and Sybase. If the WINDOW clause is not supported
     * (see {@link SelectWindowStep#window(WindowDefinition...)}, then
     * referenced windows will be inlined.
     */
    @Support({ CUBRID, POSTGRES })
    WindowFinalStep over(WindowDefinition definition);

}