com.strategicgains.restexpress.common.query

Class QueryOrder

java.lang.Object

com.strategicgains.restexpress.common.query.QueryOrder

public class QueryOrder
extends Object

Supports the concept of sorting a result based on the 'sort' query parameter. The value of the sort parameter will be the name of the field to sort on, prefixed with a dash ('-') for descending order. Sort on multiple fields by separating field names with a vertical bar ('|').

To sort on name (ascending): ?sort=name

To sort on name (descending): ?sort=-name

To sort on name (descending), description (ascending), creation date (descending): ?sort=-name|description|-createdAt

Since:

Apr 12, 2011

Author:

toddf

Constructor Summary

Constructors

Constructor and Description
QueryOrder()
QueryOrder(String... strings) Create a QueryOrder instance from an array of property names to order on, prefixed with '-' to sort descending.

Method Summary

Methods

Modifier and Type	Method and Description
QueryOrder	addSort(String... strings) Add sort order(s) to this QueryOrder instance.
boolean	isSorted() Returns true if this QueryOrder contains sort criteria.
void	iterate(OrderCallback callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOrder

public QueryOrder()

QueryOrder

public QueryOrder(String... strings)

Create a QueryOrder instance from an array of property names to order on, prefixed with '-' to sort descending.

Parameters:

strings - property name(s) to sort on (prefixed with '-' to sort descending).

Method Detail

addSort

public QueryOrder addSort(String... strings)

Add sort order(s) to this QueryOrder instance.

Parameters:

strings - property names to sort on (prefixed with '-' to sort descending).

Returns:

this QueryOrder instance to facilitate method chaining.

isSorted

public boolean isSorted()

Returns true if this QueryOrder contains sort criteria.

Returns:

true if sort criteria are present

iterate

public void iterate(OrderCallback callback)