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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaze-persistence-entity-view-api-jar Show documentation

There is a newer version: 1.6.14

Show newest version

/*
 * Copyright 2014 - 2019 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;

/**
 * An interface for building a window for analytics functions.
 *
 * @param  The builder return type
 * @author Christian Beikov
 * @since 1.4.0
 */
public interface WindowBuilder extends OrderByBuilder> {

    /**
     * Starts a filter builder.
     *
     * @param  The filter builder type
     * @return The filter builder
     */
    public  & WindowBuilder> X filter();

    /**
     * Adds a partition by clause with the given expressions to the window.
     *
     * @param partitionExpressions The expressions for the partition by clause
     * @return The window builder for chaining calls
     */
    public WindowBuilder partitionBy(String... partitionExpressions);

    /**
     * Adds a partition by clause with the given expression to the window.
     *
     * @param partitionExpression The expression for the partition by clause
     * @return The window builder for chaining calls
     */
    public WindowBuilder partitionBy(String partitionExpression);

    /**
     * Starts a frame builder with the ROWS frame mode.
     *
     * @return The frame builder
     */
    public WindowFrameBuilder rows();

    /**
     * Starts a frame builder with the RANGE frame mode.
     *
     * @return The frame builder
     */
    public WindowFrameBuilder range();

    /**
     * Starts a frame builder with the GROUPS frame mode.
     *
     * @return The frame builder
     */
    public WindowFrameBuilder groups();

    /**
     * Finishes the window builder.
     *
     * @return The parent query builder
     */
    public T end();
}