javatools.db
Class DbOrderBy

java.lang.Object
  |
  +--javatools.db.DbOrderBy

public class DbOrderBy

extends java.lang.Object

A class that represents an ORDER BY clause in a SELECT. An order by clause consists of a column and an optional DESC descending clause. Usually this class will not be referred to directly in an application. More usually you will use DbSelector.addOrderBy().

Constructor Summary

DbOrderBy(DbExpr column, boolean descending)
Creates a new DbOrderBy expression.

Method Summary

DbExpr	getColumn() The column to sort on.
boolean	getDescending() Is this clause descending order?
java.lang.String	getQueryString() Returns the query string related to these expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbOrderBy

public DbOrderBy(DbExpr column,
                 boolean descending)

Creates a new DbOrderBy expression.

Parameters:

column - The column to be used for sorting.

descending - true: if the order is descending; false: if the order is ascending.

Method Detail

getDescending

public boolean getDescending()

Is this clause descending order?

Returns:

true: if the order is descending; false: if the order is ascending.

getColumn

public DbExpr getColumn()

The column to sort on.

Returns:

The column.

getQueryString

public java.lang.String getQueryString()
                                throws DbException

Returns the query string related to these expression.

Returns:

The requested query string.

Throws:

DbException - If something goes wrong.