org.hibernate.criterion

Class Order

java.lang.Object

org.hibernate.criterion.Order

All Implemented Interfaces:

Serializable

public class Order
extends Object
implements Serializable

Represents an ordering imposed upon the results of a Criteria

Author:

Gavin King, Lukasz Antoniak (lukasz dot antoniak at gmail dot com)

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Order(String propertyName, boolean ascending) Constructor for Order.

Method Summary

Modifier and Type	Method and Description
static Order	asc(String propertyName) Ascending order
static Order	desc(String propertyName) Descending order.
String	getPropertyName()
Order	ignoreCase() Should this ordering ignore case? Has no effect on non-character properties.
boolean	isAscending()
boolean	isIgnoreCase()
Order	nulls(NullPrecedence nullPrecedence) Defines precedence for nulls.
String	toSqlString(Criteria criteria, CriteriaQuery criteriaQuery) Render the SQL fragment
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Order

protected Order(String propertyName,
                boolean ascending)

Constructor for Order. Order instances are generally created by factory methods.

See Also:

asc(java.lang.String), desc(java.lang.String)

Method Detail

asc

public static Order asc(String propertyName)

Ascending order

Parameters:

propertyName - The property to order on

Returns:

The build Order instance

desc

public static Order desc(String propertyName)

Descending order.

Parameters:

propertyName - The property to order on

Returns:

The build Order instance

ignoreCase

public Order ignoreCase()

Should this ordering ignore case? Has no effect on non-character properties.

Returns:

this, for method chaining

nulls

public Order nulls(NullPrecedence nullPrecedence)

Defines precedence for nulls.

Parameters:

nullPrecedence - The null precedence to use

Returns:

this, for method chaining

getPropertyName

public String getPropertyName()

isAscending

public boolean isAscending()

isIgnoreCase

public boolean isIgnoreCase()

toSqlString

public String toSqlString(Criteria criteria,
                          CriteriaQuery criteriaQuery)

Render the SQL fragment

Parameters:

criteria - The criteria

criteriaQuery - The overall query

Returns:

The ORDER BY fragment for this ordering

toString

public String toString()

Overrides:

toString in class Object