org.apache.beehive.netui.databinding.datagrid.api.sort
Class Sort

Object
  Sort

All Implemented Interfaces:

Serializable

public class Sort
extends Object
implements Serializable

The Sort class is a JavaBean that abstractly represents the data needed to calculate a sort on some data set. A sort consists of some String expression and a SortDirection. The mechanism for performing the sort is not provided here.

A Sort object can be used by some sorting infrastructure to either parameterise a SQL or XQuery query or to simply sort in-memory Java objects. For example, when converting a Sort into a SQL fragment, a Sort with sortExpression "foo" and sortDirection SortDirection.DESCENDING could be converted into:

     ORDER BY FOO DESC
 

See Also:

Serialized Form

Sort

public Sort()

Empty constructor.

Sort

public Sort(String sortExpression,
            SortDirection sortDirection)

Constructs a Sort with the given sortExpression and sortDirection.

Parameters:

sortExpression - the Sort's sort expression

sortDirection - the Sort's sort direction

getSortExpression

public String getSortExpression()

Get the sort expression

Returns:

the sort expression

setSortExpression

public void setSortExpression(String expression)

Set the sort expression

Parameters:

expression - the sort expression

getDirection

public SortDirection getDirection()

Get the SortDirection

Returns:

the sort direction

setDirection

public void setDirection(SortDirection sortDirection)

Set the SortDirection

Parameters:

sortDirection - the sort direction