org.jooq.WindowSpecification Maven / Gradle / Ivy
/*
* 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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import org.jooq.impl.DSL;
import org.jooq.impl.QOM;
import org.jooq.impl.QOM.FrameExclude;
import org.jooq.impl.QOM.FrameUnits;
import org.jooq.impl.QOM.UnmodifiableList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.ApiStatus.Experimental;
/**
* A window specification.
*
* Window specifications are the syntactic clauses that can be passed to both
* window definitions in WINDOW clauses, as well as to the
* OVER clause of window functions. This makes window
* specifications highly reusable across several queries.
*
* Example:
* WindowSpecification spec =
* DSL.partitionBy(BOOK.AUTHOR_ID)
* .orderBy(BOOK.ID)
* .rowsBetweenUnboundedPreceding()
* .andCurrentRow();
*
*
* Instances can be created using {@link DSL#partitionBy(Field...)},
* {@link DSL#orderBy(OrderField...)}, and overloads as well as rows / range /
* groups related methods in {@link DSL}.
*
* @author Lukas Eder
*/
public interface WindowSpecification extends QueryPart {
// -------------------------------------------------------------------------
// XXX: Query Object Model
// -------------------------------------------------------------------------
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@Nullable WindowDefinition $windowDefinition();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@NotNull UnmodifiableList> $partitionBy();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@NotNull UnmodifiableList> $orderBy();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@Nullable FrameUnits $frameUnits();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@Nullable Integer $frameStart();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@Nullable Integer $frameEnd();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@Nullable FrameExclude $exclude();
}