Package org.hibernate.query.sqm.tree.select

Class SqmSortSpecification

java.lang.Object

org.hibernate.query.sqm.tree.select.SqmSortSpecification

All Implemented Interfaces:

Order, Serializable, JpaCriteriaNode, JpaOrder

public class SqmSortSpecification
extends Object
implements JpaOrder

Author:

Steve Ebersole

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SqmSortSpecification(SqmExpression sortExpression)
SqmSortSpecification(SqmExpression sortExpression, SortDirection sortOrder)
SqmSortSpecification(SqmExpression sortExpression, SortDirection sortOrder, NullPrecedence nullPrecedence)
SqmSortSpecification(SqmExpression sortExpression, SortDirection sortOrder, NullPrecedence nullPrecedence, boolean ignoreCase)

Method Summary

Modifier and Type	Method	Description
void	appendHqlString(StringBuilder sb)
SqmSortSpecification	copy(SqmCopyContext context)
boolean	equals(Object o)
JpaExpression<?>	getExpression()	The expression to sort by
NullPrecedence	getNullPrecedence()	The precedence for nulls for this order element
SortDirection	getSortDirection()	The direction, ascending or descending, in which to sort
SqmExpression<?>	getSortExpression()
int	hashCode()
boolean	isAscending()	Whether ascending ordering is in effect.
boolean	isIgnoreCase()
JpaOrder	nullPrecedence(NullPrecedence nullPrecedence)	Set the precedence of nulls for this order element
JpaOrder	reverse()	Reverse the sorting direction

Methods inherited from class java.lang.Object

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

Constructor Details

SqmSortSpecification

public SqmSortSpecification(SqmExpression sortExpression,
 SortDirection sortOrder,
 NullPrecedence nullPrecedence)

SqmSortSpecification

public SqmSortSpecification(SqmExpression sortExpression,
 SortDirection sortOrder,
 NullPrecedence nullPrecedence,
 boolean ignoreCase)

SqmSortSpecification

public SqmSortSpecification(SqmExpression sortExpression)

SqmSortSpecification

public SqmSortSpecification(SqmExpression sortExpression,
 SortDirection sortOrder)

Method Details

copy

public SqmSortSpecification copy(SqmCopyContext context)

getSortExpression

public SqmExpression<?> getSortExpression()

getSortDirection

public SortDirection getSortDirection()

Description copied from interface: JpaOrder

The direction, ascending or descending, in which to sort

Specified by:

getSortDirection in interface JpaOrder

isIgnoreCase

public boolean isIgnoreCase()

nullPrecedence

public JpaOrder nullPrecedence(NullPrecedence nullPrecedence)

Description copied from interface: JpaOrder

Set the precedence of nulls for this order element

Specified by:

nullPrecedence in interface JpaOrder

getNullPrecedence

public NullPrecedence getNullPrecedence()

Description copied from interface: JpaOrder

The precedence for nulls for this order element

Specified by:

getNullPrecedence in interface JpaOrder

reverse

public JpaOrder reverse()

Description copied from interface: JpaOrder

Reverse the sorting direction

Specified by:

reverse in interface JpaOrder

Specified by:

reverse in interface Order

Returns:

a new Order instance with the reversed ordering

getExpression

public JpaExpression<?> getExpression()

Description copied from interface: JpaOrder

The expression to sort by

Specified by:

getExpression in interface JpaOrder

Specified by:

getExpression in interface Order

Returns:

expression used for ordering

isAscending

public boolean isAscending()

Description copied from interface: Order

Whether ascending ordering is in effect.

Specified by:

isAscending in interface Order

Returns:

boolean indicating whether ordering is ascending

appendHqlString

public void appendHqlString(StringBuilder sb)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object