|
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.PlSql oracle.javatools.db.SpecPlSql oracle.javatools.db.datatypes.ComplexType
public class ComplexType
Implementation of DataType for ComplexTypes. This classes extends PlSql to inherit the ability to store PlSql source, attributes and methods are required by a ComplexType.
Nested Class Summary | |
---|---|
static class |
ComplexType.SQLJUsingType
|
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject |
---|
AbstractDBObject.ChildSupport |
Field Summary | |
---|---|
static java.lang.String |
BODY_TYPE
|
static java.lang.String |
COLLECTION_TYPECODE
|
static java.lang.String |
OBJECT_TYPECODE
|
static java.lang.String |
TABLE_TYPE
|
static java.lang.String |
TYPE
|
static java.lang.String |
VARRAY_TYPE
|
Fields inherited from class oracle.javatools.db.PlSql |
---|
BLOCK_TYPE |
Fields inherited from interface oracle.javatools.db.datatypes.DataType |
---|
PCTROWTYPE, PCTTYPE, REF |
Fields inherited from interface oracle.javatools.db.DBObject |
---|
COMMENT |
Constructor Summary | |
---|---|
ComplexType()
|
|
ComplexType(java.lang.String name,
Schema schema)
|
Method Summary | |
---|---|
void |
addDeclaratorError(java.lang.String error)
|
DBObject |
copyTo(DBObject target,
DBObject copyParent,
IDPolicy idPolicy)
Internal copy method used by the API to perform copy operations. |
protected void |
copyToImpl(ComplexType copy,
DBObject copyParent,
IDPolicy idPolicy)
|
DataTypeUsage |
createDefaultUsage()
Returns an DataTypeUsage object for this type. |
DataTypeUsage |
createUsage(java.util.Map<java.lang.String,java.lang.Object> attributes)
Returns an DataTypeUsage object for this type, populated with attributes. |
DataTypeUsage |
createUsage(java.lang.String usageString)
Returns an DataTypeUsage object for this type, populated with attributes based on the usageString. |
boolean |
equals(java.lang.Object target)
|
protected boolean |
equalsImpl(ComplexType target)
|
java.lang.String |
getCollectionType()
Returns the code for the Type for Collection ComplexTypes - either VARRAY or TABLE. |
DataTypeAttribute |
getDataTypeAttribute(java.lang.String name)
Returns the DataTypeAttribute with the given name, if this DataType has such an attribute. |
DataTypeAttribute[] |
getDataTypeAttributes()
Returns the DataTypeAttributes for this DataType. |
java.lang.String |
getDDL(DataTypeUsage dataTypeUsage)
Generates the DDL for this type. |
java.util.List<java.lang.String> |
getDeclaratorErrors()
|
java.lang.Integer |
getLimit()
|
DataTypeUsage |
getOfTypeUsage()
|
java.lang.String |
getOID()
|
protected void |
getOwnedObjectsImpl(java.util.Collection<DBObject> c,
java.lang.String... types)
Implementation first checks that the object has been built - then returns the collection from suprt.getOwnedObjectsImpl(). |
protected void |
getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl(). |
java.lang.String |
getSqljExternalName()
|
ComplexType.SQLJUsingType |
getSqljUsing()
|
java.lang.String |
getType()
Returns the type of this object. |
java.lang.String |
getTypeCode()
Returns the code for the flavour of ComplexType - either ComplexType or collection type. |
DBObjectID |
getUnderTypeID()
|
boolean |
hasDataTypeAttribute(java.lang.String name)
Returns true if this DataTYpe has the given attribute name. |
boolean |
isAuthidCurrentUser()
|
boolean |
isFinal()
Whether this object type can be the supertype to another object type |
boolean |
isInstantiable()
Whether an object can be defined to be of this type. |
boolean |
isMadeDeclarative()
|
boolean |
matches(java.lang.String usageString)
Returns true if the usageString is valid syntax for the DataType,
false otherwise. |
boolean |
replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
Override in subclasses to replace reference IDs as appropriate. |
void |
setAuthidCurrentUser(boolean authidCurrentUser)
|
void |
setCollectionType(java.lang.String collType)
|
void |
setFinal(boolean isFinal)
Set whether this object type can be the supertype to another object type. |
void |
setInstantiable(boolean isInstantiable)
Set whether an object can be defined to be of this type. |
void |
setLimit(java.lang.Integer limit)
|
void |
setMadeDeclarative(boolean madeDeclarative)
|
void |
setOfTypeUsage(DataTypeUsage ofTypeUsage)
|
void |
setOID(java.lang.String oid)
|
void |
setSource(java.lang.String source)
|
void |
setSqljExternalName(java.lang.String sqljExternalName)
|
void |
setSqljUsing(ComplexType.SQLJUsingType sqljUsing)
|
void |
setTypeCode(java.lang.String typeCode)
|
void |
setUnderTypeID(DBObjectID underTypeID)
|
void |
validateDefaultValue(java.lang.Object defaultValue,
DataTypeUsage dataTypeUsage,
DBObject dbObject)
Validates defaultValue for dataTypeUsage against self's definition. |
void |
validateUsage(DataTypeUsage dataTypeUsage,
DBObject dbObject)
Validates dataTypeUsage against self's definition. |
Methods inherited from class oracle.javatools.db.SpecPlSql |
---|
addAttribute, addAttribute, addMethod, addMethod, copyToImpl, equalsImpl, getAttribute, getAttributes, getBodySource, getBodySourceInterrogator, getMethod, getMethods, removeAttribute, removeMethod, setAttributes, setBodySource, setMethods |
Methods inherited from class oracle.javatools.db.PlSql |
---|
copyToImpl, equalsImpl, getSource, getSourceInterrogator, isPlSql |
Methods inherited from class oracle.javatools.db.AbstractSchemaObject |
---|
addObjectListener, copyToImpl, equalsImpl, getParent, getSchema, removeObjectListener, setSchema |
Methods inherited from class oracle.javatools.db.AbstractBuildableObject |
---|
addObjectListener, checkInit, checkInit, checkInitEx, copyToImpl, equalsImpl, fireObjectUpdated, 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, 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, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getReferenceIDs, setID, setName |
Methods inherited from interface oracle.javatools.util.DynamicPropertySet |
---|
getProperties, getProperty, getProperty, setProperties, setProperty |
Methods inherited from interface oracle.javatools.db.SchemaObject |
---|
addObjectListener, getSchema, removeObjectListener, setSchema |
Methods inherited from interface oracle.javatools.db.SystemObject |
---|
addObjectListener, fireObjectUpdated, removeObjectListener |
Field Detail |
---|
public static final java.lang.String TYPE
public static final java.lang.String OBJECT_TYPECODE
public static final java.lang.String COLLECTION_TYPECODE
public static final java.lang.String BODY_TYPE
public static final java.lang.String TABLE_TYPE
public static final java.lang.String VARRAY_TYPE
Constructor Detail |
---|
public ComplexType()
public ComplexType(java.lang.String name, Schema schema)
Method Detail |
---|
public java.lang.String getType()
DBObject
getType
in interface DBObject
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 boolean equals(java.lang.Object target)
equals
in class java.lang.Object
protected void copyToImpl(ComplexType copy, DBObject copyParent, IDPolicy idPolicy)
protected boolean equalsImpl(ComplexType target)
protected void getOwnedObjectsImpl(java.util.Collection<DBObject> c, java.lang.String... types)
AbstractBuildableObject
getOwnedObjectsImpl
in class AbstractBuildableObject
c
- a Collection of the apppropriate children.types
- a vararg of the type(s) to search forAbstractDBObject.includesType(java.lang.String, java.lang.String...)
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 boolean isFinal()
public void setFinal(boolean isFinal)
isFinal
- true if no subtypes are to be allowed, false otherwisepublic boolean isInstantiable()
public void setInstantiable(boolean isInstantiable)
isInstantiable
- set true if an object can be of this typepublic java.lang.String getTypeCode()
public void setTypeCode(java.lang.String typeCode)
public java.lang.String getCollectionType()
public void setCollectionType(java.lang.String collType)
public void setAuthidCurrentUser(boolean authidCurrentUser)
public boolean isAuthidCurrentUser()
public void setLimit(java.lang.Integer limit)
public java.lang.Integer getLimit()
public void setOfTypeUsage(DataTypeUsage ofTypeUsage)
public DataTypeUsage getOfTypeUsage()
public void setUnderTypeID(DBObjectID underTypeID)
public DBObjectID getUnderTypeID()
public java.lang.String getDDL(DataTypeUsage dataTypeUsage)
DataType
getDDL
in interface DataType
public DataTypeAttribute[] getDataTypeAttributes()
DataType
getDataTypeAttributes
in interface DataType
public boolean hasDataTypeAttribute(java.lang.String name)
DataType
hasDataTypeAttribute
in interface DataType
public DataTypeAttribute getDataTypeAttribute(java.lang.String name)
DataType
getDataTypeAttribute
in interface DataType
public DataTypeUsage createDefaultUsage()
DataType
createDefaultUsage
in interface DataType
public DataTypeUsage createUsage(java.util.Map<java.lang.String,java.lang.Object> attributes)
DataType
createUsage
in interface DataType
public void validateUsage(DataTypeUsage dataTypeUsage, DBObject dbObject) throws DataTypeValidationException
DataType
validateUsage
in interface DataType
dataTypeUsage
- : the usage to be validateddbObject
- : the context of the data type usage
DataTypeValidationException
public void validateDefaultValue(java.lang.Object defaultValue, DataTypeUsage dataTypeUsage, DBObject dbObject) throws DefaultValueValidationException
DataType
validateDefaultValue
in interface DataType
defaultValue
- : the default valuedataTypeUsage
- : the usage to be validateddbObject
- : the context of the data type usage
DefaultValueValidationException
public void setOID(java.lang.String oid)
public java.lang.String getOID()
public void setSqljExternalName(java.lang.String sqljExternalName)
public java.lang.String getSqljExternalName()
public void setSqljUsing(ComplexType.SQLJUsingType sqljUsing)
public ComplexType.SQLJUsingType getSqljUsing()
public final void setMadeDeclarative(boolean madeDeclarative)
public final boolean isMadeDeclarative()
public void setSource(java.lang.String source)
setSource
in interface SourceObject
setSource
in class PlSql
public boolean matches(java.lang.String usageString)
DataType
true
if the usageString is valid syntax for the DataType,
false
otherwise.
Should be overridden by sub-classes to do the validation.
matches
in interface DataType
public DataTypeUsage createUsage(java.lang.String usageString)
DataType
DataType.matches(java.lang.String)
.
Should be overridden by sub-classes to return an object of the sub-class type.
createUsage
in interface DataType
public void addDeclaratorError(java.lang.String error)
public java.util.List<java.lang.String> getDeclaratorErrors()
|
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 |