Class WindowFunctionSupport

java.lang.Object

org.hibernate.dialect.function.spi.WindowFunctionSupport

@SPI({USE,SUPPLY})
public final class WindowFunctionSupport
extends Object

Immutable description of a Dialect's native window-function syntax.

Providers supply a stable profile through Dialect.getWindowFunctionSupport(). Baseline window functions, window partitioning, each frame unit, and non-default frame exclusion are reported independently so consumers can validate the exact syntax they render. Do not infer support for one frame unit from another.

Every refinement requires WindowFunctionSupport.Feature.WINDOW_FUNCTIONS. In addition, WindowFunctionSupport.Feature.FRAME_EXCLUSION requires at least one supported frame unit. Providers refining a family profile should copy the profile returned by the superclass and change only the features which differ.

This profile does not describe function-specific window restrictions or restrictions on individual frame bounds.

Since:

8.0

See Also:

• Dialect.getWindowFunctionSupport()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WindowFunctionSupport.Builder	Build an immutable window-function-support profile.
static enum	WindowFunctionSupport.Feature	An independently configurable window-function syntax feature.

Field Summary

Fields

Modifier and Type	Field	Description
static final WindowFunctionSupport	NONE	No native window-function syntax.
static final WindowFunctionSupport	STANDARD	The base-Dialect profile, which has no native window-function syntax.

Method Summary

Modifier and Type	Method	Description
static WindowFunctionSupport.Builder	builder()	Create a builder initialized from STANDARD.
static WindowFunctionSupport.Builder	builder(WindowFunctionSupport base)	Create a builder initialized with every feature from the given profile.
Set<WindowFunctionSupport.Feature>	getFeatures()	The immutable set of supported window-function syntax features.
boolean	supports(WindowFunctionSupport.Feature feature)	Whether the given window-function syntax feature is supported natively.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NONE

public static final WindowFunctionSupport NONE

No native window-function syntax.

STANDARD

public static final WindowFunctionSupport STANDARD

The base-Dialect profile, which has no native window-function syntax.

Method Details

builder

public static WindowFunctionSupport.Builder builder()

Create a builder initialized from STANDARD.

builder

public static WindowFunctionSupport.Builder builder(WindowFunctionSupport base)

Create a builder initialized with every feature from the given profile.

Parameters:

base - the non-null profile to copy

getFeatures

public Set<WindowFunctionSupport.Feature> getFeatures()

The immutable set of supported window-function syntax features.

supports

public boolean supports(WindowFunctionSupport.Feature feature)

Whether the given window-function syntax feature is supported natively.