oracle.javatools.db.sql

Class IndexObject

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.sql.AbstractSQLFragment

oracle.javatools.db.sql.AbstractProviderUsageSQLFragment

oracle.javatools.db.sql.IndexObject

All Implemented Interfaces:

ChildDBObject, DBObject, ProviderUsage, SQLFragment, Copyable

public class IndexObject
extends AbstractProviderUsageSQLFragment

Object to wrap a column expression (usually just a name, but could be any sql expression) with an optional order type (ASC/DESC). For example this is used by Index to represent each element in the index expression list.

Since:

10.1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexObject.OrderType

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

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASC Deprecated. - Use OrderType.ASC
static java.lang.String	DESC Deprecated. - Use OrderType.DESC
static java.lang.String	TYPE

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

AS, COMMA, DEFAULT_SEPARATOR, EMPTY, EMPTY_ARRAY, INDENT, LEFT_PAREN, NEWLINE, RIGHT_PAREN, SPACE

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

CONNECTBY, FROM, GROUPBY, HAVING, MODEL, NOCYCLE, ORDERBY, ORDERSIBLINGSBY, PRIOR, SELECT, STARTWITH, WHERE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
IndexObject() Constructs and empty Index object.
IndexObject(SQLFragment exp) Constructs an Index object with the given expression and no ordering.
IndexObject(SQLFragment exp, IndexObject.OrderType orderType) Constructs an Index object with the given expression and ordering constraint (either IndexObject.DESC or IndexObject.ASC).
IndexObject(SQLFragment exp, java.lang.String ordering) Deprecated. - Use IndexObject(SQLFragment,OrderType)

Method Summary

Modifier and Type	Method and Description
SQLFragment	getExpression() Gets the expression for this Index object which is derived from the expression source.
java.lang.String	getExpressionSource() Gets the expression source for this Index object.
java.lang.String	getName() Retrieves the name of this object.
java.lang.String	getOrder() Deprecated. - Use getOrderType()
IndexObject.OrderType	getOrderType() Gets the ordering for this clause (can be null).
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 which should be derived from the expression source.
void	setExpressionSource(java.lang.String exp) Sets the expression source for this Index object.
void	setOrder(java.lang.String order) Deprecated. - Use setOrderType(oracle.javatools.db.sql.IndexObject.OrderType)
void	setOrderType(IndexObject.OrderType orderType) Sets the ordering of this Index object.

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

areNamesEqual, copyToImpl, getDatabaseDescriptor, getExternalName, getInternalName, setProvider

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

appendToBuffer, appendToBuffer, argsToString, getStartOffset, getTextOrNull, getTextOrNull, setStartOffset, surroundWithBrackets, surroundWithBrackets, toString

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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, setParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

ASC

@Deprecated
public static final java.lang.String ASC

Deprecated. - Use OrderType.ASC

Ascending order (ASC)

See Also:

Constant Field Values

DESC

@Deprecated
public static final java.lang.String DESC

Deprecated. - Use OrderType.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. Using this constructor will call getSQLText on the given expression to set the "expression source" property.

IndexObject

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

Deprecated. - Use IndexObject(SQLFragment,OrderType)

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

IndexObject

public IndexObject(SQLFragment exp,
                   IndexObject.OrderType orderType)

Constructs an Index object with the given expression and ordering constraint (either IndexObject.DESC or IndexObject.ASC). Using this constructor will call getSQLText() on the given expression to set the "expression source" property.

Parameters:

exp - the expression as a SQLFragment (will set the expression source property as well

orderType - the order type for this object

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

@Deprecated
public java.lang.String getOrder()

Deprecated. - Use getOrderType()

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

setOrder

@Deprecated
public void setOrder(java.lang.String order)

Deprecated. - Use setOrderType(oracle.javatools.db.sql.IndexObject.OrderType)

Sets the ordering of this Index object.

getOrderType

public IndexObject.OrderType getOrderType()

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

setOrderType

public void setOrderType(IndexObject.OrderType orderType)

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

getExpressionSource

public java.lang.String getExpressionSource()

Gets the expression source for this Index object.

setExpressionSource

public void setExpressionSource(java.lang.String exp)

Sets the expression source for this Index object.

getExpression

public SQLFragment getExpression()

Gets the expression for this Index object which is derived from the expression source.

setExpression

public void setExpression(SQLFragment exp)

Sets the expression for this Index object which should be derived from the expression source. This will not set the expression source property, that should already be set before this is called.

Parameters:

exp - the SQLFragment representation of the "expression source" property.

See Also:

setExpressionSource(String)

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.

getName

public java.lang.String getName()

Description copied from interface: DBObject

Retrieves the name of this object.

Specified by:

getName in interface DBObject

Overrides:

getName in class AbstractSQLFragment

Returns:

a string containing the name of this object.