com.haulmont.cuba.core.global

Class Sort

java.lang.Object

com.haulmont.cuba.core.global.Sort

All Implemented Interfaces:

java.io.Serializable

public class Sort
extends java.lang.Object
implements java.io.Serializable

Defines sorting of queries.

Based on the Sort class from Spring Data project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sort.Direction Sort direction.
static class	Sort.Order Sort order defines a property and corresponding Sort.Direction.

Field Summary

Fields

Modifier and Type	Field and Description
static Sort	UNSORTED Undefined sort order.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Sort(java.util.List<Sort.Order> orders)
protected	Sort(Sort.Direction direction, java.util.List<java.lang.String> properties)

Method Summary

Modifier and Type	Method and Description
static Sort	by(java.util.List<Sort.Order> orders) Creates new Sort for the given list of orders.
static Sort	by(Sort.Direction direction, java.lang.String... properties) Creates new Sort for the given properties with the given direction.
static Sort	by(Sort.Order... orders) Creates new Sort for the given orders.
static Sort	by(java.lang.String... properties) Creates new Sort for the given properties with ASC direction.
java.util.List<Sort.Order>	getOrders() Returns unmodifiable list of orders.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNSORTED

public static final Sort UNSORTED

Undefined sort order.

Constructor Detail

Sort

protected Sort(java.util.List<Sort.Order> orders)

Sort

protected Sort(Sort.Direction direction,
               java.util.List<java.lang.String> properties)

Method Detail

by

public static Sort by(java.util.List<Sort.Order> orders)

Creates new Sort for the given list of orders.

by

public static Sort by(Sort.Order... orders)

Creates new Sort for the given orders.

by

public static Sort by(java.lang.String... properties)

Creates new Sort for the given properties with ASC direction.

by

public static Sort by(Sort.Direction direction,
                      java.lang.String... properties)

Creates new Sort for the given properties with the given direction.

getOrders

public java.util.List<Sort.Order> getOrders()

Returns unmodifiable list of orders.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object