oracle.javatools.db.sql
Class OrderByObject

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.sql.AbstractSQLFragment
              oracle.javatools.db.sql.OrderByObject

All Implemented Interfaces:

ChildDBObject, DBObject, SQLFragment, Copyable, DynamicPropertySet

public class OrderByObject
extends AbstractSQLFragment

Object to wrap each part of the ORDER BY clause of a SQLQuery.

Since:

10.1.3

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String	ASC Ascending order (ASC)
static java.lang.String	DESC Descending order (DESC)
static java.lang.String	NULLS_FIRST Order with null values first.
static java.lang.String	NULLS_LAST Order with null values last.
static java.lang.String	TYPE

Fields inherited from class oracle.javatools.db.sql.AbstractSQLFragment

DEFAULT_SEPARATOR, EMPTY, EMPTY_ARRAY, NEWLINE, SPACE

Fields inherited from interface oracle.javatools.db.sql.SQLFragment

CONNECTBY, FROM, GROUPBY, HAVING, NOCYCLE, ORDERBY, SELECT, STARTWITH, WHERE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

OrderByObject()
Constructs and empty ORDER BY object.

OrderByObject(SQLFragment exp)
Constructs an ORDER BY object with the given expression and no ordering.

OrderByObject(SQLFragment exp, java.lang.String ordering)
Constructs an ORDER BY object with the given expression and ordering constraint (either OrderByObject.DESC or OrderByObject.ASC)

OrderByObject(SQLFragment exp, java.lang.String ordering, java.lang.String nullsOrder)
Constructs an ORDER BY object with the given expression, ordering and null ordering.

Method Summary

SQLFragment	getExpression() Gets the expression for this ORDER BY object.
java.lang.String	getNullOrdering() Returns whether the ordering of nulls has been set (NULLS_FIRST, NULLS_LAST or null).
java.lang.String	getOrder() Gets the ordering for this clause (can be null).
java.lang.String	getSQLText() Returns the SQL for this ORDER BY object.
java.lang.String	getType() Returns the type of this object.
void	setExpression(SQLFragment exp) Sets the expression for this ORDER BY object.
void	setNullOrdering(java.lang.String nullOrdering) Sets the ordering of nulls for this order by object (NULLS_FIRST, NULLS_LAST or null).
void	setOrder(java.lang.String order) Sets the ordering of this ORDER BY object.

Methods inherited from class oracle.javatools.db.sql.AbstractSQLFragment

appendToBuffer, argsToString, getTextOrNull, getTextOrNull, setParent, surroundWithBrackets, surroundWithBrackets, toString

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

copyToImpl, findParent, getParent, getProperty, setProperty

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

ASC

public static final java.lang.String ASC

Ascending order (ASC)

See Also:

Constant Field Values

DESC

public static final java.lang.String DESC

Descending order (DESC)

See Also:

Constant Field Values

NULLS_FIRST

public static final java.lang.String NULLS_FIRST

Order with null values first.

See Also:

Constant Field Values

NULLS_LAST

public static final java.lang.String NULLS_LAST

Order with null values last.

See Also:

Constant Field Values

Constructor Detail

OrderByObject

public OrderByObject()

Constructs and empty ORDER BY object.

OrderByObject

public OrderByObject(SQLFragment exp)

Constructs an ORDER BY object with the given expression and no ordering.

OrderByObject

public OrderByObject(SQLFragment exp,
                     java.lang.String ordering)

Constructs an ORDER BY object with the given expression and ordering constraint (either OrderByObject.DESC or OrderByObject.ASC)

OrderByObject

public OrderByObject(SQLFragment exp,
                     java.lang.String ordering,
                     java.lang.String nullsOrder)

Constructs an ORDER BY object with the given expression, ordering and null ordering.

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Specified by:

getType in interface DBObject

Overrides:

getType in class AbstractSQLFragment

Returns:

a string describing the type of object.

getOrder

public java.lang.String getOrder()

Gets the ordering for this clause (can be null).

setOrder

public void setOrder(java.lang.String order)

Sets the ordering of this ORDER BY object. Must be either null, OrderByObject.ASC or OrderByObject.DESC

getNullOrdering

public java.lang.String getNullOrdering()

Returns whether the ordering of nulls has been set (NULLS_FIRST, NULLS_LAST or null).

setNullOrdering

public void setNullOrdering(java.lang.String nullOrdering)

Sets the ordering of nulls for this order by object (NULLS_FIRST, NULLS_LAST or null).

getExpression

public SQLFragment getExpression()

Gets the expression for this ORDER BY object.

setExpression

public void setExpression(SQLFragment exp)

Sets the expression for this ORDER BY object.

getSQLText

public java.lang.String getSQLText()

Returns the SQL for this ORDER BY object. Expression plus the ordering if present.

Returns:

a string representing the SQL text for this object.