oracle.javatools.db
Class Index

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.Index

All Implemented Interfaces:

Copyable, DBObject, DynamicPropertySet

public class Index

extends AbstractDBObject

Model of a database index.

Field Summary

static java.lang.String

TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Index()
Constructs a new index.

Index(java.lang.String name, Schema schema, Table table)
Deprecated. schema taken from table

Index(java.lang.String name, Table table)
Constructs a new index on the specified table using the specified name, and adds the index to the table.

Method Summary

void	addColumn(Column col) Deprecated. as of 10.1.3 replaced by addColumnExpression(IndexObject colexpr)
void	addColumnExpression(IndexObject colExpr) Adds a column to the list of indexed columns.
void	addColumnExpression(int posn, IndexObject colExpr) Insert a column into the list of indexed columns.
java.lang.Object	copyTo(java.lang.Object target) Copies the state of this DBObject to another instance.
protected void	copyToImpl(Index copy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(Index target)
IndexObject[]	getColumnExpressions() Retrieves the column expressions referenced by this index.
Column[]	getColumns() Deprecated. as of 10.1.3 replaced by getColumnExpressions()
protected void	getOwnedObjectsImpl(java.util.Collection objs, java.lang.String type) Used by all the final children methods.
DBObject	getParent() Returns the parent of this object, if one exists.
Schema	getSchema() Deprecated. - Schema taken from the parent table.
Table	getTable() Retrieves the table on which this index is defined.
java.lang.String	getType() Returns the type of this object.
void	removeColumn(Column col) Deprecated. as of 10.1.3 replaced by removeColumnExpressions(IndexObject colexpr)
void	removeColumnExpression(IndexObject colExpr) Removes a column expression from the list of indexed column expressions
void	setColumnExpressions(IndexObject[] colExprs) Sets the column expressions referenced by this index.
void	setColumns(Column[] cols) Deprecated. as of 10.1.3 replaced by setColumnExpressions(IndexObject[] colexprs)
void	setSchema(Schema schema) Deprecated. - Schema taken from the parent table.
void	setTable(Table table) Sets the table on which this index acts.

Methods inherited from class oracle.javatools.db.AbstractDBObject

compareToImpl, copyToImpl, equalsImpl, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

Index

public Index()

Constructs a new index.

Index

public Index(java.lang.String name,
             Table table)

Constructs a new index on the specified table using the specified name, and adds the index to the table.

Parameters:

name - a string containing the name of the index

table - the table on which to create the index

Index

public Index(java.lang.String name,
             Schema schema,
             Table table)

Deprecated. schema taken from table

Constructs a new index on the specified table using the specified name and schema, and adds the index to the table.

Parameters:

name - a string containing the name of the index

schema - the schema in which to create the index

table - the table on which to create the index

Method Detail

copyTo

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

Description copied from interface: DBObject

Copies the state of this DBObject to another instance. If null is specified for the target, a new instance will be created.

The entire state of the object will be copied, with a few exceptions. In particular, any observers registered will NOT be copied. In cases where this instance contains child DBObjects, new instances of those children will be created, and the state copied to them. The copy will thus contain its own unique state; after making the copy, changing one instance will not cause any changes to occur to the copy. The properties will be copied; however, copies will not be made of the values referenced by the properties - thus, the copy will refer to the same instance as the original. Child objects that are copied will still point to the original parent; it is the responsibility of a copied parent to update the parent of copies of its children point to the copy of itself.

The ID associated with this object will not be copied. If the copy is intended to be a temporary copy of this object (to be used in a dialog editing the object for example), then the caller should explicitly set the ID of the copy to be the same as on this object. However, if the new object is intended to exist separately from this object, the caller should ensure that the new object have a different ID from this object.

Parameters:

target - The object to copy to. If target is null, a new instance will be created, and the state will be copied to that object.

Returns:

the copy.

copyToImpl

protected void copyToImpl(Index copy)

equals

public boolean equals(java.lang.Object target)

equalsImpl

protected boolean equalsImpl(Index target)

setTable

public void setTable(Table table)

Sets the table on which this index acts.

Parameters:

table - the table to which this index refers

getTable

public Table getTable()
               throws TransientMarker

Retrieves the table on which this index is defined.

Returns:

the table to which this index refers

Throws:

TransientMarker

getParent

public DBObject getParent()

Description copied from interface: DBObject

Returns the parent of this object, if one exists. This does not return the Schema for a SchemaObject. Schema's are not considered part of the ownership parent tree.

setColumns

public void setColumns(Column[] cols)

Deprecated. as of 10.1.3 replaced by setColumnExpressions(IndexObject[] colexprs)

Sets the columns referenced by this index.

Parameters:

cols - an array containing the columns referenced by this index

getColumns

public Column[] getColumns()

Deprecated. as of 10.1.3 replaced by getColumnExpressions()

Retrieves the columns referenced by this index.

Returns:

an array containing the columns referenced by this index

addColumn

public void addColumn(Column col)

Deprecated. as of 10.1.3 replaced by addColumnExpression(IndexObject colexpr)

Adds a column to the list of indexed columns.

Parameters:

col - the column to add

removeColumn

public void removeColumn(Column col)

Deprecated. as of 10.1.3 replaced by removeColumnExpressions(IndexObject colexpr)

Removes a column from the list of indexed columns

Parameters:

col - the column to remove.

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.

Returns:

a string describing the type of object.

setColumnExpressions

public void setColumnExpressions(IndexObject[] colExprs)

Sets the column expressions referenced by this index.

Parameters:

colExprs - an array containing the column expressions referenced by this index

getColumnExpressions

public IndexObject[] getColumnExpressions()

Retrieves the column expressions referenced by this index.

Returns:

an array containing the column expressions referenced by this index

addColumnExpression

public void addColumnExpression(IndexObject colExpr)

Adds a column to the list of indexed columns.

Parameters:

colExpr - the IndexObject to add

addColumnExpression

public void addColumnExpression(int posn,
                                IndexObject colExpr)

Insert a column into the list of indexed columns.

Parameters:

posn - the position of the new IndexObject

colExpr - the IndexObject to add

removeColumnExpression

public void removeColumnExpression(IndexObject colExpr)

Removes a column expression from the list of indexed column expressions

Parameters:

colExpr - the column expression to remove.

getOwnedObjectsImpl

protected void getOwnedObjectsImpl(java.util.Collection objs,
                                   java.lang.String type)

Description copied from class: AbstractDBObject

Used by all the final children methods. Subclasses should start with super.getOwnedObjectsImpl(type) and then add to the returned list.

Overrides:

getOwnedObjectsImpl in class AbstractDBObject

Parameters:

type - the type to search for

Returns:

a Collection of the apppropriate children.

getSchema

public Schema getSchema()
                 throws TransientMarker

Deprecated. - Schema taken from the parent table.

Throws:

TransientMarker

setSchema

public void setSchema(Schema schema)

Deprecated. - Schema taken from the parent table.