Top Description Methods
org.hibernate.query.criteria

public Interface JpaWindow

Known Direct Implementers
org.hibernate.query.sqm.tree.expression.SqmWindow
Annotations
@Incubating
Imports
org.hibernate.Incubating, org.hibernate.query.sqm.FrameExclusion, jakarta.persistence.criteria.Expression, .Order

Common contract for window parts used in window and aggregate functions.
Author
Marco Belladelli

Method Summary

Modifier and TypeMethod and Description
public JpaWindow

Returns:

the modified window
frameExclude
(FrameExclusion
the frame exclusion
frameExclusion
)

Set a FrameExclusion for this window's frame.

public JpaWindow

Returns:

the modified window
frameGroups
(JpaWindowFrame
the start frame
startFrame
,
JpaWindowFrame
the optional end frame
endFrame
)

Add a GROUPS frame clause to the window and define start and end JpaWindowFrame specifications.

public JpaWindow

Returns:

the modified window
frameRange
(JpaWindowFrame
the start frame
startFrame
,
JpaWindowFrame
the optional end frame
endFrame
)

Add a RANGE frame clause to the window and define start and end JpaWindowFrame specifications.

public JpaWindow

Returns:

the modified window
frameRows
(JpaWindowFrame
the start frame
startFrame
,
JpaWindowFrame
the optional end frame
endFrame
)

Add a ROWS frame clause to the window and define start and end JpaWindowFrame specifications.

public JpaWindow

Returns:

the modified window
orderBy
(Order...
the order by expressions
expressions
)

Add order by expressions to the window.

public JpaWindow

Returns:

the modified window
partitionBy
(Expression<?>...
the partition by expressions
expressions
)

Add partition by expressions to the window.

Method Detail

frameExcludeback to summary
public JpaWindow frameExclude(FrameExclusion frameExclusion)

Set a FrameExclusion for this window's frame.

Parameters
frameExclusion:FrameExclusion

the frame exclusion

Returns:JpaWindow

the modified window

frameGroupsback to summary
public JpaWindow frameGroups(JpaWindowFrame startFrame, JpaWindowFrame endFrame)

Add a GROUPS frame clause to the window and define start and end JpaWindowFrame specifications.

Parameters
startFrame:JpaWindowFrame

the start frame

endFrame:JpaWindowFrame

the optional end frame

Returns:JpaWindow

the modified window

frameRangeback to summary
public JpaWindow frameRange(JpaWindowFrame startFrame, JpaWindowFrame endFrame)

Add a RANGE frame clause to the window and define start and end JpaWindowFrame specifications.

Parameters
startFrame:JpaWindowFrame

the start frame

endFrame:JpaWindowFrame

the optional end frame

Returns:JpaWindow

the modified window

frameRowsback to summary
public JpaWindow frameRows(JpaWindowFrame startFrame, JpaWindowFrame endFrame)

Add a ROWS frame clause to the window and define start and end JpaWindowFrame specifications.

Parameters
startFrame:JpaWindowFrame

the start frame

endFrame:JpaWindowFrame

the optional end frame

Returns:JpaWindow

the modified window

orderByback to summary
public JpaWindow orderBy(Order... expressions)

Add order by expressions to the window.

Parameters
expressions:Order[]

the order by expressions

Returns:JpaWindow

the modified window

partitionByback to summary
public JpaWindow partitionBy(Expression<?>... expressions)

Add partition by expressions to the window.

Parameters
expressions:Expression<?>[]

the partition by expressions

Returns:JpaWindow

the modified window