|
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.AbstractChildDBObject oracle.javatools.db.ora.LOBDescriptor
public class LOBDescriptor
LOBDescriptor encapsulates the partitioning properties of LOB and VARRAY
columns. One or more LOBDescriptor objects are held on a TablePartition object.
For an overview of the table partitioning api, see OracleTablePartitions.
LOBDescriptors may be defined for an individual partition, partition level
subpartition or subpartition template, although only the properties are
restricted for subpartitions and hash partitions.
The following DDL shows LOB and VARRAY column definitions within a
partition, partition level subpartition and subpartition template :
create table RANGE_LIST1 ( C1 number , C2 number , C_CLOB clob , C_BLOB blob , C_VARRAY T_VARRAY ) partition by range(C1) subpartition by list(C2) subpartition template ( subpartition RANGE_LIST1_SP1 lob(C_CLOB) store as RANGE_LIST1_SP1_SEG1(tablespace EXAMPLE) ) ( partition P100 less than(100) lob(C_BLOB, C_CLOB) store as (cache reads nologging) lob(C_VARRAY) store as RANGE_LIST1_P100_SEG1(storage(freelist groups 5) nocache) ( subpartition RANGE_LIST1_P100_SP1 lob(C_CLOB) store as RANGE_LIST1_P100_SP1_SEG1(tablespace USERS) ,subpartition RANGE_LIST1_P100_SP2 varray C_VARRAY store as RANGE_LIST1_P100_SP2_SEG1 ) )
A LOBDescriptor defines :
In the following DDL clauses properties STORAGE_ENABLED_IN_ROW to STORAGE
are designated LOB_PARAMETERS.
DDL clauses for LOB and VARRAY columns of a range or list partition
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject |
---|
AbstractDBObject.ChildSupport |
Field Summary | |
---|---|
static java.lang.String |
LOB_PARAMETER_CACHE
|
static java.lang.String |
LOB_PARAMETER_CACHEREADS
|
static java.lang.String |
LOB_PARAMETER_NOCACHE
|
static java.lang.String |
TYPE
|
Fields inherited from interface oracle.javatools.db.DBObject |
---|
COMMENT |
Constructor Summary | |
---|---|
LOBDescriptor()
|
Method Summary | |
---|---|
void |
addColumn(DBObjectID column)
Add a column to the column list. |
DBObject |
copyTo(DBObject target,
DBObject copyParent,
IDPolicy idPolicy)
Internal copy method used by the API to perform copy operations. |
protected void |
copyToImpl(LOBDescriptor target,
DBObject copyParent,
IDPolicy idPolicy)
|
boolean |
equals(java.lang.Object target)
|
protected boolean |
equalsImpl(LOBDescriptor target)
|
static LOBDescriptor |
findLOBDescriptorForColumn(Column column)
|
java.lang.String |
getCache()
return the value of CACHE |
java.lang.Integer |
getChunk()
Return the value of CHUNK. |
DBObjectID[] |
getColumns()
|
java.lang.Integer |
getFreepools()
Return the value of FREEPOOLS |
java.lang.String |
getLOBSegName()
|
java.lang.String |
getName()
Retrieves the name of this object. |
protected void |
getOwnedObjectsImpl(java.util.Collection<DBObject> objs,
java.lang.String... types)
Used by all the final children methods. |
java.lang.Integer |
getPctVersion()
Return the value of PCTVERSION. |
protected void |
getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
Used by the final getReferenceID() implementation. |
OracleStorageProperties |
getStorage()
|
java.lang.String |
getType()
Returns the type of this object. |
static boolean |
isLOBColumn(Column column)
|
static boolean |
isLOBColumn(DBObjectID colID)
|
boolean |
isRetention()
|
boolean |
isStorageEnabledInRow()
|
static boolean |
isVARRAYColumn(Column column)
|
static boolean |
isVARRAYColumn(DBObjectID colID)
|
void |
removeColumn(DBObjectID column)
Remove a column from the column list. |
boolean |
replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
Override in subclasses to replace reference IDs as appropriate. |
void |
setCache(java.lang.String cache)
Set the value of CACHE |
void |
setChunk(java.lang.Integer chunk)
Set the value of CHUNK. |
void |
setColumns(DBObjectID[] columns)
Replace the column list. |
void |
setFreepools(java.lang.Integer freepools)
Set the value of FREEPOOLS. |
void |
setLOBSegName(java.lang.String name)
|
void |
setPctVersion(java.lang.Integer pctVersion)
Set the value of PCTVERSION. |
void |
setRetention(boolean retention)
|
void |
setStorage(OracleStorageProperties storage)
|
void |
setStorageEnabledInRow(boolean storageEnabledInRow)
|
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, 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, getOwnedObjects, getOwnedObjects, getReferenceIDs, setID, setName |
Methods inherited from interface oracle.javatools.util.DynamicPropertySet |
---|
getProperties, getProperty, getProperty, setProperties, setProperty |
Field Detail |
---|
public static final java.lang.String TYPE
public static final java.lang.String LOB_PARAMETER_CACHE
public static final java.lang.String LOB_PARAMETER_NOCACHE
public static final java.lang.String LOB_PARAMETER_CACHEREADS
Constructor Detail |
---|
public LOBDescriptor()
Method 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)
public java.lang.String getName()
DBObject
getName
in interface DBObject
getName
in class AbstractDBObject
public boolean equals(java.lang.Object target)
equals
in class java.lang.Object
public java.lang.String getType()
DBObject
public void setLOBSegName(java.lang.String name)
public java.lang.String getLOBSegName()
public void setColumns(DBObjectID[] columns)
columns
- public DBObjectID[] getColumns()
public void addColumn(DBObjectID column)
column
- public void removeColumn(DBObjectID column)
column
- public void setChunk(java.lang.Integer chunk)
chunk
- : null or an integer between 1 and min( next_extent, 32768 ).public java.lang.Integer getChunk()
public void setPctVersion(java.lang.Integer pctVersion)
pctVersion
- : null or an integer between 0 and 100public java.lang.Integer getPctVersion()
public void setFreepools(java.lang.Integer freepools)
freepools
- : null or a positive integerpublic java.lang.Integer getFreepools()
public void setStorage(OracleStorageProperties storage)
public OracleStorageProperties getStorage()
public void setRetention(boolean retention)
public boolean isRetention()
public void setStorageEnabledInRow(boolean storageEnabledInRow)
public boolean isStorageEnabledInRow()
public void setCache(java.lang.String cache)
cache
- : null or one of {"CACHE", "NOCACHE", "CACHE READS"}public java.lang.String getCache()
public 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 static boolean isLOBColumn(DBObjectID colID)
public static boolean isLOBColumn(Column column)
public static boolean isVARRAYColumn(DBObjectID colID)
public static boolean isVARRAYColumn(Column column)
protected void copyToImpl(LOBDescriptor target, DBObject copyParent, IDPolicy idPolicy)
protected boolean equalsImpl(LOBDescriptor target)
protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
AbstractDBObject
getReferenceIDsImpl
in class AbstractDBObject
refs
- the collection of ids this object referencesprotected void getOwnedObjectsImpl(java.util.Collection<DBObject> objs, java.lang.String... types)
AbstractDBObject
includesType
to check the types vararg.
getOwnedObjectsImpl
in class AbstractDBObject
objs
- a Collection of the apppropriate children.types
- a vararg of the type(s) to search forAbstractDBObject.includesType(java.lang.String, java.lang.String...)
public static LOBDescriptor findLOBDescriptorForColumn(Column column)
|
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 |