Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

oracle.javatools.db.ora
Class OracleIndexPartitions

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractChildDBObject
          extended by oracle.javatools.db.ora.OracleIndexPartitions
All Implemented Interfaces:
ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class OracleIndexPartitions
extends AbstractChildDBObject

Model of the partitioning scheme on an Oracle index.

Since:
11

Nested Class Summary
static class OracleIndexPartitions.PartitionType
           
 
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject
AbstractDBObject.ChildSupport
 
Field Summary
static java.lang.String KEY
           
static java.lang.String TYPE
           
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
OracleIndexPartitions()
           
OracleIndexPartitions(OracleIndexPartitions.PartitionType partitionType)
           
 
Method Summary
 void addGlobalPartitionColumn(DBObjectID partitionColumn)
           
 void addPartition(IndexPartition partition)
           
 void addTablespace(java.lang.String tablespace)
           
 java.lang.Integer getGlobalHashQuantity()
          Returns the GLOBAL HASH quantity.
 DBObjectID[] getGlobalPartitionColumns()
           
 IndexPartition[] getPartitions()
          Returns an array of IndexPartition objects.
 OracleIndexPartitions.PartitionType getPartitionType()
           
 java.lang.String[] getTablespaces()
          Returns an array of tablespace names
 java.lang.String getType()
          Returns the type of this object.
static Column[] getValidGlobalPartitionColumns(Index index)
          Returns an array of columns that are eligible for global index partitioning.
 void removeGlobalPartitionColumn(DBObjectID partitionColumn)
           
 void removePartition(IndexPartition partition)
           
 void setGlobalHashQuantity(java.lang.Integer globalHashQuantity)
          Set the GLOBAL HASH quantity.
 void setGlobalPartitionColumns(DBObjectID[] partitionColumns)
           
 void setPartitions(IndexPartition[] partitions)
           
 void setPartitionType(OracleIndexPartitions.PartitionType partitionType)
           
 void setTablespaces(java.lang.String[] tablespaces)
           
 
Methods inherited from class oracle.javatools.db.AbstractChildDBObject
copyToImpl, findParent, getParent, getProperty, setParent, setProperty
 
Methods inherited from class oracle.javatools.db.AbstractDBObject
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, 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.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperties, getProperty, setProperties
 

Field Detail

KEY

public static final java.lang.String KEY
See Also:
Constant Field Values

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values
Constructor Detail

OracleIndexPartitions

public OracleIndexPartitions()

OracleIndexPartitions

public OracleIndexPartitions(OracleIndexPartitions.PartitionType partitionType)
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.

Returns:
a string describing the type of object.

getPartitionType

public OracleIndexPartitions.PartitionType getPartitionType()

getPartitions

public IndexPartition[] getPartitions()
Returns an array of IndexPartition objects. The array may be empty.

Returns:
an array of individual index partitions or subpartitions.

getGlobalPartitionColumns

public DBObjectID[] getGlobalPartitionColumns()

getTablespaces

public java.lang.String[] getTablespaces()
Returns an array of tablespace names


getGlobalHashQuantity

public java.lang.Integer getGlobalHashQuantity()
Returns the GLOBAL HASH quantity. The value may be null.


setPartitionType

public void setPartitionType(OracleIndexPartitions.PartitionType partitionType)

setGlobalPartitionColumns

public void setGlobalPartitionColumns(DBObjectID[] partitionColumns)

addGlobalPartitionColumn

public void addGlobalPartitionColumn(DBObjectID partitionColumn)

removeGlobalPartitionColumn

public void removeGlobalPartitionColumn(DBObjectID partitionColumn)

setPartitions

public void setPartitions(IndexPartition[] partitions)

addPartition

public void addPartition(IndexPartition partition)

removePartition

public void removePartition(IndexPartition partition)

setTablespaces

public void setTablespaces(java.lang.String[] tablespaces)

addTablespace

public void addTablespace(java.lang.String tablespace)

setGlobalHashQuantity

public void setGlobalHashQuantity(java.lang.Integer globalHashQuantity)
Set the GLOBAL HASH quantity.

Parameters:
globalHashQuantity -

getValidGlobalPartitionColumns

public static Column[] getValidGlobalPartitionColumns(Index index)
Returns an array of columns that are eligible for global index partitioning. Only consecutive columns, starting with the first column, may be used as partition columns. Attempts to use a column expression or non consecutive column gives : ORA-14038: GLOBAL partitioned index must be prefixed

Parameters:
index -
Returns:

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

Copyright © 1997, 2011, Oracle. All rights reserved.