Package org.labkey.remoteapi.query

Class Sort

java.lang.Object

org.labkey.remoteapi.query.Sort

public class Sort
extends Object

Represents a particular sort order entry, which consists of a column name and an optional direction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Sort.Direction

Constructor Summary

Constructors

Constructor	Description
Sort(String columnName)
Sort(String columnName, Sort.Direction direction)
Sort(Sort source)

Method Summary

Modifier and Type	Method	Description
String	getColumnName()
Sort.Direction	getDirection()
static String	getSortQueryStringParam(List<Sort> sorts)	Constructs the sort query string parameter from the current list of sort definitions.
void	setColumnName(String columnName)
void	setDirection(Sort.Direction direction)
String	toQueryStringParam()

Methods inherited from class java.lang.Object

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

Constructor Details

Sort

public Sort(String columnName)

Sort

public Sort(String columnName,
 Sort.Direction direction)

Sort

public Sort(Sort source)

Method Details

getColumnName

public String getColumnName()

setColumnName

public void setColumnName(String columnName)

getDirection

public Sort.Direction getDirection()

setDirection

public void setDirection(Sort.Direction direction)

getSortQueryStringParam

public static String getSortQueryStringParam(List<Sort> sorts)

Constructs the sort query string parameter from the current list of sort definitions. The sort query string parameter is in the form of [-]column,[-]column,... where the optional - is used for a descending sort direction.

Parameters:

sorts - the set of sorts in the query

Returns:

The sort query string parameter.

toQueryStringParam

public String toQueryStringParam()

Returns:

a URL-style representation of this sort parameter. Column names are prefixed with "-" to represent a descending sort.