A class that can be used in an ORDER BY clause to sort the items of a resulting query. More...

#include <OrderByItem.h>

Public Member Functions
Expression *	getExpression () const
	It returns the exprsssion to be used to sort the result of a query. More...

SortOrder	getSortOrder () const
	It returns the order of sorting: Asc or Desc. More...

OrderByItem &	operator= (const OrderByItem &rhs)

	OrderByItem (const Expression &e, SortOrder order=ASC)
	Constructor. More...

	OrderByItem (Expression *e, SortOrder order=ASC)
	Constructor. More...

	OrderByItem (const std::string &propertyName, SortOrder order=ASC)
	Constructor. More...

	OrderByItem (const OrderByItem &rhs)
	Copy constructor. More...

void	setExpression (Expression *e)
	It sets the expression to sort the result of a query. More...

void	setSortOrder (SortOrder o)
	It sets the order to be used during the sorting of a query. More...

	~OrderByItem ()
	Destructor. More...

Private Attributes
std::unique_ptr< Expression >	m_field
	A valid expression. More...

SortOrder	m_order
	Sort order. More...

Detailed Description

A class that can be used in an ORDER BY clause to sort the items of a resulting query.

The order default will be ascendent if none is informed.

See also: OrderBy

Definition at line 53 of file OrderByItem.h.

Constructor & Destructor Documentation

te::da::OrderByItem::OrderByItem	(	const Expression &	e,
		SortOrder	order = `ASC`
	)

explicit

Constructor.

Parameters

e	An expression to be used in an ORDER BY clause.
order	The sort order.

te::da::OrderByItem::OrderByItem	(	Expression *	e,
		SortOrder	order = `ASC`
	)

explicit

Constructor.

Parameters

e	An expression to be used in an ORDER BY clause.
order	The sort order.

Note: The OrderByItem will take the ownership of Expression.

te::da::OrderByItem::OrderByItem	(	const std::string &	propertyName,
		SortOrder	order = `ASC`
	)

explicit

Constructor.

Parameters

propertyName	A property name.
order	The sort order.

te::da::OrderByItem::OrderByItem ( const OrderByItem & rhs )

explicit

Copy constructor.

te::da::OrderByItem::~OrderByItem ( )

Destructor.

Member Function Documentation

Expression* te::da::OrderByItem::getExpression ( ) const

It returns the exprsssion to be used to sort the result of a query.

Returns: The exprsssion to be used to sort the result of a query.

SortOrder te::da::OrderByItem::getSortOrder ( ) const

It returns the order of sorting: Asc or Desc.

Returns: The order of sorting: Asc or Desc.

OrderByItem& te::da::OrderByItem::operator= ( const OrderByItem & rhs )

Assignment operator.

void te::da::OrderByItem::setExpression ( Expression * e )

It sets the expression to sort the result of a query.

Parameters

e	The expression to be used to sort the result of a query.

Note: The OrderByItem will take the expression ownership.

void te::da::OrderByItem::setSortOrder ( SortOrder o )

It sets the order to be used during the sorting of a query.

Parameters

o	The order to be used during the sorting of a query.

Member Data Documentation

std::unique_ptr<Expression> te::da::OrderByItem::m_field

private

A valid expression.

Definition at line 124 of file OrderByItem.h.

SortOrder te::da::OrderByItem::m_order

private

Sort order.

Definition at line 125 of file OrderByItem.h.

The documentation for this class was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/dataaccess/query/OrderByItem.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation