oracle.javatools.db

Class Index

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractSystemObject

oracle.javatools.db.AbstractSchemaObject

oracle.javatools.db.Index

All Implemented Interfaces:

ChildDBObject, DBObject, SchemaObject, SystemObject, Copyable

public class Index
extends AbstractSchemaObject
implements ChildDBObject

Model of a database index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.IndexType Index type

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	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
Index() Constructs a new index.
Index(java.lang.String name, Schema schema) Constructs a new index using the specified name and schema.
Index(java.lang.String name, Schema schema, Table table) Constructs a new index on the specified table using the specified name The Index will not be added to the Table, that must be done separately when the Index definition is complete.
Index(java.lang.String name, Table table) Constructs a new index on the specified table using the specified name.

Method Summary

Modifier and Type	Method and Description
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.
protected void	copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
DBObject	findOwnedObject(DBObjectID id, boolean strict) Returns a child of this object that has the given ID.
IndexObject[]	getColumnExpressions() Retrieves the column expressions referenced by this index.
DBObjectID	getDomainIndextype()
java.lang.String	getDomainIndextypeOpStatus()
java.lang.String	getDomainIndextypeParameters()
Index.IndexType	getIndexType() Get the type of the index.
java.lang.Integer	getKeyCompression() Gets the key compression.
java.lang.Integer	getParallelDegree() Return the degree of parallelism (the number of parallel threads used in the parallel operation) where : null = no parallelism defined 0 = PARALLEL DEFAULT (Oracle server selects the degree) 1 = NOPARALLEL (default) n = PARALLEL n
java.lang.Object	getProperty(java.lang.String key) Retrieves the value associated with a property.
java.lang.Boolean	getReverse() Determines if the index is stored in reverse or not.
Schema	getSchema() Returns the owning Table's schema or schema set against this index if different.
java.lang.Boolean	getSystemGenerated() Gets the System Generated flag.
Table	getTable() Retrieves the table on which this index is defined.
java.lang.String	getType() Returns the type of this object.
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	setDomainIndextype(DBObjectID id)
void	setDomainIndextypeOpStatus(java.lang.String status)
void	setDomainIndextypeParameters(java.lang.String parameters)
void	setIndexType(Index.IndexType indexType) Set the type of the index.
void	setKeyCompression(java.lang.Integer keyCompression) Sets the key compression.
void	setParallelDegree(java.lang.Integer value) Set the degree of parallelism (the number of parallel threads used in the parallel operation) where : null = no parallelism defined 0 = PARALLEL DEFAULT (Oracle server selects the degree) 1 = NOPARALLEL (default) n = PARALLEL n
void	setParent(DBObject par) Sets the parent Table of this Index.
void	setProperty(java.lang.String key, java.lang.Object value) Sets the value for a property.
void	setReverse(java.lang.Boolean reverse) Set whether the index should be stored in reverse or not.
void	setSchema(Schema s) Sets the index's schema.
void	setSystemGenerated(java.lang.Boolean generated) Sets the System Generated flag.
void	setTable(Table table) Sets the table on which this index acts.

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, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setName, setProperties, toString

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

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

Methods inherited from interface oracle.javatools.db.SchemaObject

addObjectListener, removeObjectListener

Methods inherited from interface oracle.javatools.db.SystemObject

addObjectListener, fireObjectUpdated, removeObjectListener

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. The Index will not be added to the Table, that must be done separately when the Index definition is complete.

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)

Constructs a new index using the specified name and schema.

Parameters:

name - a string containing the name of the index

schema - the schema in which to create the index

Index

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

Constructs a new index on the specified table using the specified name The Index will not be added to the Table, that must be done separately when the Index definition is complete.

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

getIndexType

public Index.IndexType getIndexType()

Get the type of the index. Current types are:

• NORMAL
• UNIQUE
• BITMAP
• DOMAIN

Returns:

getDomainIndextype

public DBObjectID getDomainIndextype()

getDomainIndextypeParameters

public java.lang.String getDomainIndextypeParameters()

getDomainIndextypeOpStatus

public java.lang.String getDomainIndextypeOpStatus()

setParallelDegree

public void setParallelDegree(java.lang.Integer value)

Set the degree of parallelism (the number of parallel threads used in the parallel operation) where :

• null = no parallelism defined
• 0 = PARALLEL DEFAULT (Oracle server selects the degree)
• 1 = NOPARALLEL (default)
• n = PARALLEL n

Parameters:

value -

getParallelDegree

public java.lang.Integer getParallelDegree()

Return the degree of parallelism (the number of parallel threads used in the parallel operation) where :

• null = no parallelism defined
• 0 = PARALLEL DEFAULT (Oracle server selects the degree)
• 1 = NOPARALLEL (default)
• n = PARALLEL n

setIndexType

public void setIndexType(Index.IndexType indexType)

Set the type of the index. Current types are:

• NORMAL
• UNIQUE
• BITMAP
• DOMAIN

setDomainIndextype

public void setDomainIndextype(DBObjectID id)

setDomainIndextypeParameters

public void setDomainIndextypeParameters(java.lang.String parameters)

setDomainIndextypeOpStatus

public void setDomainIndextypeOpStatus(java.lang.String status)

setKeyCompression

public void setKeyCompression(java.lang.Integer keyCompression)

Sets the key compression.

1. null - NOCOMPRESS
2. 0 - COMPRESS
3. > 0 - COMPRESS integer

getKeyCompression

public java.lang.Integer getKeyCompression()

Gets the key compression.

1. null - NOCOMPRESS
2. 0 - COMPRESS
3. > 0 - COMPRESS integer

getReverse

public java.lang.Boolean getReverse()

Determines if the index is stored in reverse or not.

1. null - not specified
2. true - REVERSE
3. false - NOREVERSE

Returns:

null if not set or true if index is stored in reverse otherwise false

setReverse

public void setReverse(java.lang.Boolean reverse)

Set whether the index should be stored in reverse or not.

1. null - not specified
2. true - REVERSE
3. false - NOREVERSE

Parameters:

reverse - value to set for reverse state

setSystemGenerated

public void setSystemGenerated(java.lang.Boolean generated)

Sets the System Generated flag. This flag indicates if the index was generated to support a constraint.

getSystemGenerated

public java.lang.Boolean getSystemGenerated()

Gets the System Generated flag. This flag indicates if the index was generated to support a constraint.

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

Retrieves the table on which this index is defined. This will build build the table property (e.g. from the database dictionary) if it isn't set. Compare this with AbstractDBObject.getParent() which will simply return the current parent of this object without building anything.

Returns:

the table to which this index refers

setParent

public void setParent(DBObject par)

Sets the parent Table of this Index.

Specified by:

setParent in interface ChildDBObject

Parameters:

par - the Table that this Index is on.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Description copied from interface: DBObject

Retrieves the value associated with a property. Any key can be used, and this is how the generic DBObject model can be extended (e.g. for database specific properties) but this method will also return the value for bean properties, for example:

obj.getProperty( "name" ) == obj.getName()

Both bean and extended property names are available as constants on the Property class for properties that the db-api supports natively.

Specified by:

getProperty in interface DBObject

Overrides:

getProperty in class AbstractDBObject

Parameters:

key - the property key for which a value is desired. exists.

Returns:

the value of the requested property, or a null value if the property does not exist or is not set.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Description copied from interface: DBObject

Sets the value for a property. Setting a value to null removes that property.

Specified by:

setProperty in interface DBObject

Overrides:

setProperty in class AbstractDBObject

Parameters:

key - the property key to set

value - the value to set

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

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.

findOwnedObject

public DBObject findOwnedObject(DBObjectID id,
                                boolean strict)

Description copied from interface: DBObject

Returns a child of this object that has the given ID. The child is located by comparing IDs, not by calling resolveID() and is therefore the quickest way to locate a DBObject if you know its parent.

Note: an unstrict comparison can be time consuming, only request it if you need it (i.e. you are searching using a DBObjectID that did not originate in this object's heirarchy).

The method does not recurse to look for children of children.

This will not find SchemaObjects in a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Specified by:

findOwnedObject in interface DBObject

Overrides:

findOwnedObject in class AbstractDBObject

Parameters:

id - the id to look for

strict - whether to stricly compare IDs or not

Returns:

a child object found with a matching id, or null if no child is found

See Also:

DBObjectID.equals(DBObjectID,boolean)

getSchema

public Schema getSchema()

Returns the owning Table's schema or schema set against this index if different.

Specified by:

getSchema in interface SchemaObject

Overrides:

getSchema in class AbstractSchemaObject

Returns:

schema the Schema containing this object

setSchema

public void setSchema(Schema s)

Sets the index's schema. The schema is only remembered against the index if it is different to the owning table's schema.

Specified by:

setSchema in interface SchemaObject

Overrides:

setSchema in class AbstractSchemaObject

Parameters:

s - the Schema containing this object

copyToImpl

protected void copyToImpl(AbstractDBObject copy,
                          DBObject copyParent,
                          IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.

Overrides:

copyToImpl in class AbstractBuildableObject

Parameters:

copy - the copy being created of this object

copyParent - if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.

idPolicy - the policy for copying the object's ID.