oracle.javatools.db.ora
Class OracleIndexOrganizedTableProperties

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.ora.OracleIndexOrganizedTableProperties

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class OracleIndexOrganizedTableProperties
extends AbstractChildDBObject

Property object to hold the index organized specific properties for an IOT. For creationg, this object represents the index_org_table_clause from the CREATE TABLE statement.

Since:

11.0

Nested Class Summary

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

OracleIndexOrganizedTableProperties()

OracleIndexOrganizedTableProperties(java.lang.Integer pctThreshold, boolean mapped, java.lang.Integer keyCompression, DBObjectID includeColum, boolean overflowable, OracleStorageProperties overflowProperties)

Method Summary

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(OracleIndexOrganizedTableProperties copy, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(OracleIndexOrganizedTableProperties target)
DBObjectID	getIncludeColumn() Gets the column (if any) to put in the INCLUDE clause.
java.lang.Integer	getKeyCompression() Gets the key compression.
OracleStorageProperties	getOverflowProperties() Gets the overflow properties that are used if the table is marked as overflowable.
protected void	getOwnedObjectsImpl(java.util.Collection<DBObject> objs, java.lang.String... types) Used by all the final children methods.
java.lang.Integer	getPctThreshold() Gets the PCTTHRESHOLD property.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
java.lang.String	getType() Returns the type of this object.
boolean	isMapped() Gets whether to include MAPPING TABLE or NOMAPPING.
boolean	isOverflowable() Gets whether to include an overflow clause.
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
void	setIncludeColumn(DBObjectID columnID) Sets the column (if any) to put in the INCLUDE clause.
void	setKeyCompression(java.lang.Integer keyCompression) Sets the key compression.
void	setMapped(boolean mapped) Sets whether to include a MAPPING TABLE (true) or NOMAPPING (false).
void	setOverflowable(boolean overflowable) Sets whether to include an overflow clause.
void	setOverflowProperties(OracleStorageProperties overflowProperties) Sets the overflow properties that are used if the table is marked as overflowable.
void	setPctThreshold(java.lang.Integer pctThreshold) Sets the PCTTHRESHOLD property.

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, 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

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

Constructor Detail

OracleIndexOrganizedTableProperties

public OracleIndexOrganizedTableProperties()

OracleIndexOrganizedTableProperties

public OracleIndexOrganizedTableProperties(java.lang.Integer pctThreshold,
                                           boolean mapped,
                                           java.lang.Integer keyCompression,
                                           DBObjectID includeColum,
                                           boolean overflowable,
                                           OracleStorageProperties overflowProperties)

Method Detail

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)

copyToImpl

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

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(OracleIndexOrganizedTableProperties target)

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.

setPctThreshold

public void setPctThreshold(java.lang.Integer pctThreshold)

Sets the PCTTHRESHOLD property. This can be null (no PCTTHRESHOLD specified) or a positive int less than 50.

getPctThreshold

public java.lang.Integer getPctThreshold()

Gets the PCTTHRESHOLD property.

See Also:

setPctThreshold(java.lang.Integer)

setMapped

public void setMapped(boolean mapped)

Sets whether to include a MAPPING TABLE (true) or NOMAPPING (false). Default is NOMAPPING.

isMapped

public boolean isMapped()

Gets whether to include MAPPING TABLE or NOMAPPING.

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.

See Also:

setKeyCompression(java.lang.Integer)

setIncludeColumn

public void setIncludeColumn(DBObjectID columnID)

Sets the column (if any) to put in the INCLUDE clause.

getIncludeColumn

public DBObjectID getIncludeColumn()

Gets the column (if any) to put in the INCLUDE clause.

setOverflowable

public void setOverflowable(boolean overflowable)

Sets whether to include an overflow clause.

See Also:

setOverflowProperties(oracle.javatools.db.ora.OracleStorageProperties)

isOverflowable

public boolean isOverflowable()

Gets whether to include an overflow clause.

setOverflowProperties

public void setOverflowProperties(OracleStorageProperties overflowProperties)

Sets the overflow properties that are used if the table is marked as overflowable.

See Also:

setOverflowable(boolean)

getOverflowProperties

public OracleStorageProperties getOverflowProperties()

Gets the overflow properties that are used if the table is marked as overflowable.

See Also:

#getOverflowable

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

getOwnedObjectsImpl

protected void getOwnedObjectsImpl(java.util.Collection<DBObject> objs,
                                   java.lang.String... types)

Description copied from class: AbstractDBObject

Used by all the final children methods. Subclasses should start with super.getOwnedObjectsImpl(type) and then add to the passed list. Use includesType to check the types vararg.

Overrides:

getOwnedObjectsImpl in class AbstractDBObject

Parameters:

objs - a Collection of the apppropriate children.

types - a vararg of the type(s) to search for

See Also:

AbstractDBObject.includesType(java.lang.String, java.lang.String...)