Class SqmSortSpecification

java.lang.Object

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

All Implemented Interfaces:

Order, Serializable, JpaCriteriaNode, JpaOrder, SqmCacheable

public class SqmSortSpecification
extends Object
implements JpaOrder, SqmCacheable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SqmSortSpecification(SqmExpression sortExpression)
SqmSortSpecification(SqmExpression<?> sortExpression, SortDirection sortOrder, Nulls nullPrecedence, boolean ignoreCase)
SqmSortSpecification(SqmExpression sortExpression, SortDirection sortOrder)
SqmSortSpecification(SqmExpression sortExpression, SortDirection sortOrder, Nulls nullPrecedence)
SqmSortSpecification(SqmExpression sortExpression, SortDirection sortOrder, NullPrecedence nullPrecedence)	Deprecated, for removal: This API element is subject to removal in a future version. Use SqmSortSpecification(SqmExpression, SortDirection, Nulls) instead

Method Summary

Modifier and Type	Method	Description
void	appendHqlString(StringBuilder sb, SqmRenderContext context)
int	cacheHashCode()
SqmSortSpecification	copy(SqmCopyContext context)
boolean	equals(@Nullable Object other)
JpaExpression<?>	getExpression()	The expression to sort by
Nulls	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()
boolean	isCompatible(Object other)
boolean	isIgnoreCase()
JpaOrder	nullPrecedence(Nulls nullPrecedence)	Set the precedence of nulls for this order element
JpaOrder	reverse()	Reverse the sorting direction

Methods inherited from class Object

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

Constructor Details

SqmSortSpecification

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

SqmSortSpecification

public SqmSortSpecification(SqmExpression<?> sortExpression,
 SortDirection sortOrder,
 Nulls nullPrecedence,
 boolean ignoreCase)

SqmSortSpecification

@Deprecated(since="7",
            forRemoval=true)
public SqmSortSpecification(SqmExpression sortExpression,
 SortDirection sortOrder,
 NullPrecedence nullPrecedence)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SqmSortSpecification(SqmExpression, SortDirection, Nulls) instead

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(Nulls nullPrecedence)

Description copied from interface: JpaOrder

Set the precedence of nulls for this order element

Specified by:

nullPrecedence in interface JpaOrder

getNullPrecedence

public Nulls getNullPrecedence()

Description copied from interface: JpaOrder

The precedence for nulls for this order element

Specified by:

getNullPrecedence in interface JpaOrder

Specified by:

getNullPrecedence in interface Order

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

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

isAscending

public boolean isAscending()

Specified by:

isAscending in interface Order

appendHqlString

public void appendHqlString(StringBuilder sb,
 SqmRenderContext context)

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(Object other)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable