oracle.javatools.db.ora
Class OracleIndexPartitions

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          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)
DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(OracleIndexPartitions target, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(OracleIndexPartitions target)
java.lang.Integer	getGlobalHashQuantity() Returns the GLOBAL HASH quantity.
DBObjectID[]	getGlobalPartitionColumns()
IndexPartition[]	getPartitions() Returns an array of IndexPartition objects.
OracleIndexPartitions.PartitionType	getPartitionType()
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
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)
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
void	setGlobalHashQuantity(java.lang.Integer hashQuantity) 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, setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, setID, setName, setProperties, setProperty, 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, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

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

Set the GLOBAL HASH quantity.

Parameters:

hashQuantity -

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)

Description copied from class: AbstractDBObject

Override in subclasses to replace reference IDs as appropriate. Always call super in the overridden implementation to make sure the default implementation (which checks the property map) is called.

Specified by:

replaceReferenceIDs in interface DBObject

Overrides:

replaceReferenceIDs in class AbstractDBObject

Parameters:

idMap - key = old DBObjectID, value = new DBObjectID

Returns:

true if any ids were replaced.

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)

Description copied from class: AbstractDBObject

Used by the final getReferenceID() implementation. The list should not contain null values, or be null. Subclasses should start with super.getReferenceIDsImpl() and then add to the passed list as appopriate.

Overrides:

getReferenceIDsImpl in class AbstractDBObject

Parameters:

refs - the collection of ids this object references

copyToImpl

protected void copyToImpl(OracleIndexPartitions target,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equalsImpl

protected boolean equalsImpl(OracleIndexPartitions target)

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: