Class SqmWindow

java.lang.Object

org.hibernate.query.sqm.tree.spi.AbstractSqmNode

org.hibernate.query.sqm.tree.spi.expression.SqmWindow

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaWindow, SqmCacheable, SqmNode, SqmVisitableNode

@Incubating(since="6.2")
public class SqmWindow
extends AbstractSqmNode
implements JpaWindow, SqmVisitableNode

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmWindow(NodeBuilder nodeBuilder)
SqmWindow(NodeBuilder nodeBuilder, List<SqmExpression<?>> partitions, List<SqmSortSpecification> orderList, FrameMode mode, FrameKind startKind, SqmExpression<?> startExpression, FrameKind endKind, SqmExpression<?> endExpression, FrameExclusion exclusion)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
int	cacheHashCode()
SqmWindow	copy(SqmCopyContext context)
boolean	equals(Object object)
JpaWindow	frameExclude(FrameExclusion frameExclusion)	Set a FrameExclusion for this window's frame.
JpaWindow	frameGroups(JpaWindowFrame startFrame, JpaWindowFrame endFrame)	Add a GROUPS frame clause to the window and define start and end JpaWindowFrame specifications.
JpaWindow	frameRange(JpaWindowFrame startFrame, JpaWindowFrame endFrame)	Add a RANGE frame clause to the window and define start and end JpaWindowFrame specifications.
JpaWindow	frameRows(JpaWindowFrame startFrame, JpaWindowFrame endFrame)	Add a ROWS frame clause to the window and define start and end JpaWindowFrame specifications.
SqmExpression<?>	getEndExpression()
FrameKind	getEndKind()
FrameExclusion	getExclusion()
FrameMode	getMode()
List<SqmSortSpecification>	getOrderList()
List<SqmExpression<?>>	getPartitions()
SqmExpression<?>	getStartExpression()
FrameKind	getStartKind()
int	hashCode()
boolean	isCompatible(Object object)
JpaWindow	orderBy(Order... orders)	Add order by expressions to the window.
JpaWindow	partitionBy(Expression<?>... expressions)	Add partition by expressions to the window.

Methods inherited from class AbstractSqmNode

nodeBuilder

Methods inherited from class Object

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

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmVisitableNode

toHqlString

Constructor Details

SqmWindow

public SqmWindow(@Nonnull
 NodeBuilder nodeBuilder)

SqmWindow

public SqmWindow(@Nonnull
 NodeBuilder nodeBuilder,
 @Nonnull
 List<SqmExpression<?>> partitions,
 @Nonnull
 List<SqmSortSpecification> orderList,
 @Nonnull
 FrameMode mode,
 @Nonnull
 FrameKind startKind,
 @Nullable
 SqmExpression<?> startExpression,
 @Nonnull
 FrameKind endKind,
 @Nullable
 SqmExpression<?> endExpression,
 @Nonnull
 FrameExclusion exclusion)

Method Details

getPartitions

@Nonnull
public List<SqmExpression<?>> getPartitions()

getOrderList

@Nonnull
public List<SqmSortSpecification> getOrderList()

getStartExpression

@Nullable
public SqmExpression<?> getStartExpression()

getEndExpression

@Nullable
public SqmExpression<?> getEndExpression()

getMode

@Nonnull
public FrameMode getMode()

getStartKind

@Nonnull
public FrameKind getStartKind()

getEndKind

@Nonnull
public FrameKind getEndKind()

getExclusion

@Nonnull
public FrameExclusion getExclusion()

frameRows

@Nonnull
public JpaWindow frameRows(@Nullable
 JpaWindowFrame startFrame,
 @Nullable
 JpaWindowFrame endFrame)

Description copied from interface: JpaWindow

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

Specified by:

frameRows in interface JpaWindow

Parameters:

startFrame - the start frame

endFrame - the optional end frame

Returns:

the modified window

frameRange

@Nonnull
public JpaWindow frameRange(@Nullable
 JpaWindowFrame startFrame,
 @Nullable
 JpaWindowFrame endFrame)

Description copied from interface: JpaWindow

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

Specified by:

frameRange in interface JpaWindow

Parameters:

startFrame - the start frame

endFrame - the optional end frame

Returns:

the modified window

frameGroups

@Nonnull
public JpaWindow frameGroups(@Nullable
 JpaWindowFrame startFrame,
 @Nullable
 JpaWindowFrame endFrame)

Description copied from interface: JpaWindow

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

Specified by:

frameGroups in interface JpaWindow

Parameters:

startFrame - the start frame

endFrame - the optional end frame

Returns:

the modified window

frameExclude

@Nonnull
public JpaWindow frameExclude(@Nonnull
 FrameExclusion frameExclusion)

Description copied from interface: JpaWindow

Set a FrameExclusion for this window's frame.

Specified by:

frameExclude in interface JpaWindow

Parameters:

frameExclusion - the frame exclusion

Returns:

the modified window

partitionBy

@Nonnull
public JpaWindow partitionBy(@Nonnull
 Expression<?>... expressions)

Description copied from interface: JpaWindow

Add partition by expressions to the window.

Specified by:

partitionBy in interface JpaWindow

Parameters:

expressions - the partition by expressions

Returns:

the modified window

orderBy

@Nonnull
public JpaWindow orderBy(@Nonnull
 Order... orders)

Description copied from interface: JpaWindow

Add order by expressions to the window.

Specified by:

orderBy in interface JpaWindow

Parameters:

orders - the order by expressions

Returns:

the modified window

copy

@Nonnull
public SqmWindow copy(@Nonnull
 SqmCopyContext context)

Specified by:

copy in interface SqmNode

accept

@Nullable
public <X> X accept(@Nonnull
 SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

appendHqlString

public void appendHqlString(@Nonnull
 StringBuilder hql,
 @Nonnull
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(@Nullable
 Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable