oracle.jdeveloper.cm.ds.db
Class Index

java.lang.Object
  oracle.jdeveloper.cm.ds.db.DBObject
      oracle.jdeveloper.cm.ds.db.SchemaObject
          oracle.jdeveloper.cm.ds.db.Index

All Implemented Interfaces:

Copyable

public class Index

extends SchemaObject

Model of a database index.

Field Summary

Fields inherited from class oracle.jdeveloper.cm.ds.db.DBObject

ANONYMOUS_BLOCK, COLUMN, CONSTRAINT, FUNCTION, INDEX, PACKAGE_BODY, PACKAGE_SPEC, PROCEDURE, SEQUENCE, SYNONYM, TABLE, WORKAREA

Constructor Summary

Index()
Constructor

Index(java.lang.String name)

Index(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, java.lang.String name)

Method Summary

void	addColumn(java.lang.String col)
java.lang.Object	clone()
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(Index copy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(Index target)
java.util.Iterator	getChildren() If this object has subobjects (i.e.
java.util.List	getColumns()
int	getIndexType() Gets the index type
java.lang.String	getTableName()
java.lang.String	getType() Returns the type of object this is.
void	setColumns(java.util.List cols)
void	setIndexType(int indexType) Sets the index type
void	setTableName(java.lang.String tableName)
java.lang.String	toString()

Methods inherited from class oracle.jdeveloper.cm.ds.db.SchemaObject

copyToImpl, equalsImpl, getCatalog, getSchema, setCatalog, setSchema

Methods inherited from class oracle.jdeveloper.cm.ds.db.DBObject

copyToImpl, equalsImpl, getName, setName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Index

public Index()

Constructor

Index

public Index(java.lang.String name)

Index

public Index(java.lang.String catalog,
             java.lang.String schema,
             java.lang.String tableName,
             java.lang.String name)

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

public Object copyTo( Object target )
{
final <this_class> copy =
target != null ? (<this_class>) target : new <this_class>();
copyToImpl( copy );
return copy;
} protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Specified by:

copyTo in class DBObject

copyToImpl

protected void copyToImpl(Index copy)

equals

public boolean equals(java.lang.Object target)

Specified by:

equals in class DBObject

equalsImpl

protected boolean equalsImpl(Index target)

setTableName

public void setTableName(java.lang.String tableName)

getTableName

public java.lang.String getTableName()

setColumns

public void setColumns(java.util.List cols)

getColumns

public java.util.List getColumns()

addColumn

public void addColumn(java.lang.String col)

setIndexType

public void setIndexType(int indexType)

Sets the index type

getIndexType

public int getIndexType()

Gets the index type

toString

public java.lang.String toString()

Overrides:

toString in class DBObject

getType

public java.lang.String getType()

Description copied from class: DBObject

Returns the type of object this is. The object type is defined as constants in DBObject

Specified by:

getType in class DBObject

See Also:

DBObject.TABLE, DBObject.WORKAREA, DBObject.COLUMN

clone

public java.lang.Object clone()

getChildren

public java.util.Iterator getChildren()

Description copied from class: DBObject

If this object has subobjects (i.e. a table contains columns), then this will return an Iterator on that list of children, otherwise it will return null.

Specified by:

getChildren in class DBObject