Package org.mybatis.dynamic.sql.select

Class SimpleSortSpecification

java.lang.Object

org.mybatis.dynamic.sql.select.SimpleSortSpecification

All Implemented Interfaces:

SortSpecification

public class SimpleSortSpecification
extends Object
implements SortSpecification

This class is used for an order by phrase where there is no suitable column name to use (for example a calculated column or an aggregate column).

Author:

Jeff Butler

Method Summary

Modifier and Type	Method	Description
SortSpecification	descending()	Returns a new instance of the SortSpecification that should render as descending in an ORDER BY clause.
boolean	isDescending()	Return true if the sort order is descending.
static SimpleSortSpecification	of(String name)
String	orderByName()	Return the phrase that should be written into a rendered order by clause.

Methods inherited from class java.lang.Object

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

Method Details

descending

public SortSpecification descending()

Description copied from interface: SortSpecification

Returns a new instance of the SortSpecification that should render as descending in an ORDER BY clause.

Specified by:

descending in interface SortSpecification

Returns:

new instance of SortSpecification

orderByName

public String orderByName()

Description copied from interface: SortSpecification

Return the phrase that should be written into a rendered order by clause. This should NOT include the "DESC" word for descending sort specifications.

Specified by:

orderByName in interface SortSpecification

Returns:

the order by phrase

isDescending

public boolean isDescending()

Description copied from interface: SortSpecification

Return true if the sort order is descending.

Specified by:

isDescending in interface SortSpecification

Returns:

true if the SortSpecification should render as descending

of

public static SimpleSortSpecification of(String name)