org.castor.cpa.query.object

Class OrderImpl

java.lang.Object

org.castor.cpa.query.object.AbstractQueryObject

org.castor.cpa.query.object.OrderImpl

All Implemented Interfaces:

Order, QueryObject

public final class OrderImpl
extends AbstractQueryObject
implements Order

Final class that implements Order.

Since:

1.3

Version:

$Revision: 7121 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Udai Gupta, Ralf Joachim

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderImpl.Item Inner class for order items to handel field and its order direction together.

Constructor Summary

Constructors

Constructor and Description
OrderImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Field field) Adds the field object to the order object of query objects.
void	add(Field field, OrderDirection direction) Adds the field object with order direction specification to the order object of query objects.
List<OrderImpl.Item>	getItems() Get list of order items.
StringBuilder	toString(StringBuilder sb) Append a string representation of the object to the given StringBuilder.

Methods inherited from class org.castor.cpa.query.object.AbstractQueryObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderImpl

public OrderImpl()

Method Detail

add

public void add(Field field)

Adds the field object to the order object of query objects.

Specified by:

add in interface Order

Parameters:

field - The field object of query objects

add

public void add(Field field,
       OrderDirection direction)

Adds the field object with order direction specification to the order object of query objects.

Specified by:

add in interface Order

Parameters:

field - The Field

direction - The OrderDirective

getItems

public List<OrderImpl.Item> getItems()

Get list of order items.

Returns:

List of order items.

toString

public StringBuilder toString(StringBuilder sb)

Append a string representation of the object to the given StringBuilder. In general, the toString method for query objects appends a string that textually represents this object. The result should be a query string that complies to EJB QL specification as long as the query object represents a syntay element of it. It is required that all subclasses override this method. The toString method defined at class Object is overwritten and calls this method.

Specified by:

toString in interface QueryObject

Parameters:

sb - StringBuilder to append the string representation of this object to.

Returns:

Same instance of StringBuilder given as parameter.