|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.javatools.db.AbstractDBObject oracle.javatools.db.AbstractBuildableObject oracle.javatools.db.AbstractSchemaObject oracle.javatools.db.Index
public class Index
Model of a database index.
Nested Class Summary | |
---|---|
static class |
Index.IndexType
Index type |
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject |
---|
AbstractDBObject.ChildSupport |
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)
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 and schema, and adds the index to the 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. |
DBObject |
copyTo(DBObject target,
DBObject copyParent,
IDPolicy idPolicy)
Internal copy method used by the API to perform copy operations. |
protected void |
copyToImpl(Index copy,
Table copyParent,
IDPolicy idPolicy)
|
boolean |
equals(java.lang.Object target)
|
protected boolean |
equalsImpl(Index target)
|
DBObject |
findOwnedObject(DBObjectID id)
Returns a child of this object that has the given ID. |
IndexObject[] |
getColumnExpressions()
Retrieves the column expressions referenced by this index. |
Column[] |
getColumns()
Deprecated. as of 10.1.3 replaced by getColumnExpressions() |
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. |
int |
getParallelDegree()
Return the degree of parallelism (the number of parallel threads used in the parallel operation) where : 0 = PARALLEL DEFAULT (Oracle server selects the degree) 1 = NOPARALLEL (default) n = PARALLEL n |
DBObject |
getParent()
Returns the parent of this object, if one exists. |
protected void |
getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl(). |
Schema |
getSchema()
Returns the owning Table's schema or schema set against this index if different. |
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 |
boolean |
replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
Override in subclasses to replace reference IDs as appropriate. |
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 |
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(int value)
Set the degree of parallelism (the number of parallel threads used in the parallel operation) where : 0 = PARALLEL DEFAULT (Oracle server selects the degree) 1 = NOPARALLEL (default) n = PARALLEL n |
void |
setParent(DBObject par)
Sets the parent of this object. |
void |
setSchema(Schema s)
Sets the index's schema. |
void |
setTable(Table table)
Sets the table on which this index acts. |
Methods inherited from class oracle.javatools.db.AbstractSchemaObject |
---|
addObjectListener, copyToImpl, equalsImpl, removeObjectListener |
Methods inherited from class oracle.javatools.db.AbstractBuildableObject |
---|
addObjectListener, checkInit, checkInit, checkInitEx, copyToImpl, equalsImpl, fireObjectUpdated, getOwnedObjectsImpl, getProperties, getProperty, getProperty, needsInitialization, removeObjectListener, setProperties, setProperty |
Methods inherited from class oracle.javatools.db.AbstractDBObject |
---|
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, setID, setName, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.javatools.db.DBObject |
---|
copyTo, copyTo, copyTo, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, setID, setName |
Methods inherited from interface oracle.javatools.util.DynamicPropertySet |
---|
getProperties, getProperty, getProperty, setProperties, setProperty |
Methods inherited from interface oracle.javatools.db.SystemObject |
---|
addObjectListener, fireObjectUpdated, removeObjectListener |
Field Detail |
---|
public static final java.lang.String TYPE
Constructor Detail |
---|
public Index()
public Index(java.lang.String name, Table table)
name
- a string containing the name of the indextable
- the table on which to create the indexpublic Index(java.lang.String name, Schema schema)
name
- a string containing the name of the indexschema
- the schema in which to create the indexpublic Index(java.lang.String name, Schema schema, Table table)
name
- a string containing the name of the indexschema
- the schema in which to create the indextable
- the table on which to create the indexMethod Detail |
---|
public DBObject copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy)
AbstractDBObject
This method does not fix internal reference ids on copy. That is done by
the calling DBObject.copyTo(DBObject, IDPolicy)
method.
copyTo
in class AbstractDBObject
DBObject.copyTo(java.lang.Object)
,
DBObject.copyTo(DBObject, boolean)
,
AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)
protected void copyToImpl(Index copy, Table copyParent, IDPolicy idPolicy)
public boolean equals(java.lang.Object target)
equals
in class java.lang.Object
protected boolean equalsImpl(Index target)
public Index.IndexType getIndexType()
public DBObjectID getDomainIndextype()
public java.lang.String getDomainIndextypeParameters()
public java.lang.String getDomainIndextypeOpStatus()
public int getParallelDegree()
public void setIndexType(Index.IndexType indexType)
public void setDomainIndextype(DBObjectID id)
public void setDomainIndextypeParameters(java.lang.String parameters)
public void setDomainIndextypeOpStatus(java.lang.String status)
public void setParallelDegree(int value)
value
- public void setKeyCompression(java.lang.Integer keyCompression)
null
- NOCOMPRESS0
- COMPRESS> 0
- COMPRESS integer
public java.lang.Integer getKeyCompression()
null
- NOCOMPRESS0
- COMPRESS> 0
- COMPRESS integer
public void setTable(Table table)
table
- the table to which this index referspublic Table getTable()
public DBObject getParent()
DBObject
getParent
in interface ChildDBObject
getParent
in interface DBObject
getParent
in class AbstractSchemaObject
public void setParent(DBObject par)
ChildDBObject
setParent
in interface ChildDBObject
public java.lang.String getType()
DBObject
getType
in interface DBObject
public void setColumnExpressions(IndexObject[] colExprs)
colExprs
- an array containing the column expressions
referenced by this indexpublic IndexObject[] getColumnExpressions()
public void addColumnExpression(IndexObject colExpr)
colExpr
- the IndexObject to addpublic void addColumnExpression(int posn, IndexObject colExpr)
posn
- the position of the new IndexObjectcolExpr
- the IndexObject to addpublic void removeColumnExpression(IndexObject colExpr)
colExpr
- the column expression to remove.protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
AbstractBuildableObject
getReferenceIDsImpl
in class AbstractBuildableObject
refs
- the collection of ids this object referencespublic boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
AbstractDBObject
replaceReferenceIDs
in interface DBObject
replaceReferenceIDs
in class AbstractDBObject
idMap
- key = old DBObjectID, value = new DBObjectID
public DBObject findOwnedObject(DBObjectID id)
AbstractDBObject
findOwnedObject
in interface DBObject
findOwnedObject
in class AbstractDBObject
id
- the id to look for
public Schema getSchema()
getSchema
in interface SchemaObject
getSchema
in class AbstractSchemaObject
public void setSchema(Schema s)
setSchema
in interface SchemaObject
setSchema
in class AbstractSchemaObject
s
- the Schema containing this object@Deprecated public void setColumns(Column[] cols)
cols
- an array containing the columns referenced by this index@Deprecated public Column[] getColumns()
@Deprecated public void addColumn(Column col)
col
- the column to add@Deprecated public void removeColumn(Column col)
col
- the column to remove.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |