Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

oracle.javatools.db.sql
Class OrderByObject

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractChildDBObject
          extended by oracle.javatools.db.sql.AbstractSQLFragment
              extended by 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
 DBObject copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy)
          Internal copy method used by the API to perform copy operations.
protected  void copyToImpl(OrderByObject target, DBObject copyParent, IDPolicy idPolicy)
           
 boolean equals(java.lang.Object obj)
           
protected  boolean equalsImpl(OrderByObject other)
           
 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).
protected  void getOwnedObjectsImpl(java.util.Collection<DBObject> objs, java.lang.String... types)
          Used by all the final children methods.
 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 nullsFirstOrLast)
          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
 
Methods inherited from class oracle.javatools.db.AbstractDBObject
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty
 
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 nullsFirstOrLast)
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.

getOwnedObjectsImpl

protected void getOwnedObjectsImpl(java.util.Collection<DBObject> objs,
                                   java.lang.String... types)
Description copied from class: AbstractDBObject
Used by all the final children methods. Subclasses should start with super.getOwnedObjectsImpl(type) and then add to the passed list. Use includesType to check the types vararg.

Overrides:
getOwnedObjectsImpl in class AbstractDBObject
Parameters:
objs - a Collection of the apppropriate children.
types - a vararg of the type(s) to search for
See Also:
AbstractDBObject.includesType(java.lang.String, java.lang.String...)

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)
Description copied from class: AbstractDBObject
Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:
copyTo in class AbstractDBObject
See Also:
DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

copyToImpl

protected void copyToImpl(OrderByObject target,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equalsImpl

protected boolean equalsImpl(OrderByObject other)

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

Copyright © 1997, 2010, Oracle. All rights reserved.