io.quarkus.panache.common

Class Sort

java.lang.Object

io.quarkus.panache.common.Sort

public class Sort
extends Object

Utility class to build and represent SQL sorting specifications. A Sort instance represents a list of columns to sort on, each with a direction to use for sorting.

Usage:

 Sort sort = Sort.by("name").and("age", Direction.Descending);
 Sort sort2 = Sort.ascending("name", "age");
 Sort sort3 = Sort.descending("name", "age");
 

Author:

Stéphane Épardaud

See Also:

Sort.Direction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Sort.Column
static class	Sort.Direction Represents an SQL direction in which to sort results.

Method Summary

Modifier and Type	Method and Description
Sort	and(String name) Adds a sort column, in ascending order.
Sort	and(String name, Sort.Direction direction) Adds a sort column, in the given order.
Sort	ascending() Sets the order to ascending for all current sort columns.
static Sort	ascending(String... columns) Sort by the given columns, in ascending order.
static Sort	by(String... columns) Sort by the given columns, in ascending order.
static Sort	by(String column) Sort by the given column, in ascending order.
static Sort	by(String column, Sort.Direction direction) Sort by the given column, in the given order.
Sort	descending() Sets the order to descending for all current sort columns.
static Sort	descending(String... columns) Sort by the given columns, in descending order.
Sort	direction(Sort.Direction direction) Sets the order to all current sort columns.
List<Sort.Column>	getColumns() Get the sort columns
String	toOrderBy() Deprecated. panache-common should be agnostic from the database implementation

Methods inherited from class java.lang.Object

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

Method Detail

by

public static Sort by(String column)

Sort by the given column, in ascending order.

Parameters:

column - the column to sort on, in ascending order.

Returns:

a new Sort instance which sorts on the given column in ascending order.

See Also:

by(String, Direction), by(String...)

by

public static Sort by(String column,
                      Sort.Direction direction)

Sort by the given column, in the given order.

Parameters:

column - the column to sort on, in the given order.

direction - the direction to sort on

Returns:

a new Sort instance which sorts on the given column in the given order.

See Also:

by(String), by(String...)

by

public static Sort by(String... columns)

Sort by the given columns, in ascending order. Equivalent to ascending(String...).

Parameters:

columns - the columns to sort on, in ascending order.

Returns:

a new Sort instance which sorts on the given columns in ascending order.

See Also:

by(String, Direction), by(String), ascending(String...), descending(String...)

ascending

public static Sort ascending(String... columns)

Sort by the given columns, in ascending order. Equivalent to by(String...).

Parameters:

columns - the columns to sort on, in ascending order.

Returns:

a new Sort instance which sorts on the given columns in ascending order.

See Also:

by(String, Direction), by(String), by(String...), descending(String...)

descending

public static Sort descending(String... columns)

Sort by the given columns, in descending order.

Parameters:

columns - the columns to sort on, in descending order.

Returns:

a new Sort instance which sorts on the given columns in descending order.

See Also:

by(String, Direction), by(String), descending(String...)

descending

public Sort descending()

Sets the order to descending for all current sort columns.

Returns:

this instance, modified.

See Also:

ascending(), direction(Direction)

ascending

public Sort ascending()

Sets the order to ascending for all current sort columns.

Returns:

this instance, modified.

See Also:

descending(), direction(Direction)

direction

public Sort direction(Sort.Direction direction)

Sets the order to all current sort columns.

Parameters:

direction - the direction to use for all current sort columns.

Returns:

this instance, modified.

See Also:

descending(), ascending()

and

public Sort and(String name)

Adds a sort column, in ascending order.

Parameters:

name - the new column to sort on, in ascending order.

Returns:

this instance, modified.

See Also:

and(String, Direction)

and

public Sort and(String name,
                Sort.Direction direction)

Adds a sort column, in the given order.

Parameters:

name - the new column to sort on, in the given order.

Returns:

this instance, modified.

See Also:

and(String)

getColumns

public List<Sort.Column> getColumns()

Get the sort columns

Returns:

the sort columns

toOrderBy

@Deprecated
public String toOrderBy()

Deprecated. panache-common should be agnostic from the database implementation

Returns an SQL "order by" clause for the current sort columns and directions.

Returns:

an SQL "order by" clause for the current sort columns and directions.