|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.javatools.db.AbstractDBObject oracle.javatools.db.AbstractChildDBObject oracle.javatools.db.sql.AbstractSQLFragment oracle.javatools.db.sql.OrderByObject
public class OrderByObject
Object to wrap each part of the ORDER BY clause of a SQLQuery.
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 |
---|
public static final java.lang.String TYPE
public static final java.lang.String ASC
public static final java.lang.String DESC
public static final java.lang.String NULLS_FIRST
public static final java.lang.String NULLS_LAST
Constructor Detail |
---|
public OrderByObject()
public OrderByObject(SQLFragment exp)
public OrderByObject(SQLFragment exp, java.lang.String ordering)
public OrderByObject(SQLFragment exp, java.lang.String ordering, java.lang.String nullsOrder)
Method Detail |
---|
public java.lang.String getType()
DBObject
getType
in interface DBObject
getType
in class AbstractSQLFragment
public java.lang.String getOrder()
null
).
public void setOrder(java.lang.String order)
null
,
OrderByObject.ASC
or OrderByObject.DESC
public java.lang.String getNullOrdering()
public void setNullOrdering(java.lang.String nullsFirstOrLast)
public SQLFragment getExpression()
public void setExpression(SQLFragment exp)
public java.lang.String getSQLText()
protected void getOwnedObjectsImpl(java.util.Collection<DBObject> objs, java.lang.String... types)
AbstractDBObject
includesType
to check the types vararg.
getOwnedObjectsImpl
in class AbstractDBObject
objs
- a Collection of the apppropriate children.types
- a vararg of the type(s) to search forAbstractDBObject.includesType(java.lang.String, java.lang.String...)
public DBObject copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy)
AbstractDBObject
This method does not fix internal reference ids on copy. That is done by
the calling DBObject.copyTo(DBObject, IDPolicy)
method.
copyTo
in class AbstractDBObject
DBObject.copyTo(java.lang.Object)
,
DBObject.copyTo(DBObject, boolean)
,
AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)
protected void copyToImpl(OrderByObject target, DBObject copyParent, IDPolicy idPolicy)
protected boolean equalsImpl(OrderByObject other)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |