oracle.javatools.db.sql
Class IndexObject

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

All Implemented Interfaces:

ChildDBObject, DBObject, SQLFragment, Copyable, DynamicPropertySet

public class IndexObject
extends AbstractSQLFragment

Object to wrap each column eaxpression of the Index statement

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	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

IndexObject()
Constructs and empty Index object.

IndexObject(SQLFragment exp)
Constructs an Index object with the given expression and no ordering.

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

Method Summary

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(IndexObject target, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object obj)
protected boolean	equalsImpl(IndexObject other)
SQLFragment	getExpression() Gets the expression for this Index object.
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 Index object.
java.lang.String	getType() Returns the type of this object.
void	setExpression(SQLFragment exp) Sets the expression for this Index object.
void	setOrder(java.lang.String order) Sets the ordering of this Index 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

Constructor Detail

IndexObject

public IndexObject()

Constructs and empty Index object.

IndexObject

public IndexObject(SQLFragment exp)

Constructs an Index object with the given expression and no ordering.

IndexObject

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

Constructs an Index object with the given expression and ordering constraint (either IndexObject.DESC or IndexObject.ASC)

Method Detail

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 Index object. Must be either null, OrderByObject.ASC or OrderByObject.DESC

getExpression

public SQLFragment getExpression()

Gets the expression for this Index object.

setExpression

public void setExpression(SQLFragment exp)

Sets the expression for this Index object.

getSQLText

public java.lang.String getSQLText()

Returns the SQL for this Index 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(IndexObject target,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equalsImpl

protected boolean equalsImpl(IndexObject other)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

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.