Interface SortParameters

All Known Implementing Classes:

DefaultSortParameters

public interface SortParameters

Entity containing the parameters for the SORT operation.

Author:

Costin Leau, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SortParameters.Order	Sorting order.
static class	SortParameters.Range	Utility class wrapping the 'LIMIT' setting.

Method Summary

Modifier and Type	Method	Description
byte @Nullable []	getByPattern()	Returns the pattern (if set) for sorting by external keys (BY).
byte @Nullable [][]	getGetPattern()	Returns the pattern (if set) for retrieving external keys (GET).
@Nullable SortParameters.Range	getLimit()	Returns the sorting limit (range or pagination).
@Nullable SortParameters.Order	getOrder()	Returns the sorting order.
@Nullable Boolean	isAlphabetic()	Indicates if the sorting is numeric (default) or alphabetical (lexicographical).

Method Details

getOrder

@Nullable SortParameters.Order getOrder()

Returns the sorting order. Can be null if nothing is specified.

Returns:

sorting order. null if not set.

isAlphabetic

@Nullable Boolean isAlphabetic()

Indicates if the sorting is numeric (default) or alphabetical (lexicographical). Can be null if nothing is specified.

Returns:

the type of sorting. null if not set.

getByPattern

byte @Nullable [] getByPattern()

Returns the pattern (if set) for sorting by external keys (BY). Can be null if nothing is specified.

Returns:

BY pattern. null if not set.

getGetPattern

byte @Nullable [][] getGetPattern()

Returns the pattern (if set) for retrieving external keys (GET). Can be null if nothing is specified.

Returns:

GET pattern. null if not set.

getLimit

@Nullable SortParameters.Range getLimit()

Returns the sorting limit (range or pagination). Can be null if nothing is specified.

Returns:

sorting limit/range. null if not set.