Class SqmWindow

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

All Implemented Interfaces:

Serializable, JpaCriteriaNode, JpaWindow, SqmCacheable, SqmNode, SqmVisitableNode

@Incubating
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, @Nullable SqmExpression<?> startExpression, FrameKind endKind, @Nullable 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(@Nullable 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.
@Nullable SqmExpression<?>	getEndExpression()
FrameKind	getEndKind()
FrameExclusion	getExclusion()
FrameMode	getMode()
List<SqmSortSpecification>	getOrderList()
List<SqmExpression<?>>	getPartitions()
@Nullable 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(NodeBuilder nodeBuilder)

SqmWindow

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

Method Details

getPartitions

public List<SqmExpression<?>> getPartitions()

getOrderList

public List<SqmSortSpecification> getOrderList()

getStartExpression

public @Nullable SqmExpression<?> getStartExpression()

getEndExpression

public @Nullable SqmExpression<?> getEndExpression()

getMode

public FrameMode getMode()

getStartKind

public FrameKind getStartKind()

getEndKind

public FrameKind getEndKind()

getExclusion

public FrameExclusion getExclusion()

frameRows

public JpaWindow frameRows(JpaWindowFrame startFrame,
 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

public JpaWindow frameRange(JpaWindowFrame startFrame,
 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

public JpaWindow frameGroups(JpaWindowFrame startFrame,
 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

public JpaWindow frameExclude(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

public JpaWindow partitionBy(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

public JpaWindow orderBy(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

public SqmWindow copy(SqmCopyContext context)

Specified by:

copy in interface SqmNode

accept

public <X> X accept(SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

appendHqlString

public void appendHqlString(StringBuilder hql,
 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(Object object)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable