|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-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.plsql.DBObjectPlSqlFragment
oracle.javatools.db.plsql.PlSqlDatatype
public class PlSqlDatatype
Representation of a PL/SQL Datatype sucj as a record, varray table etc.
Nested Class Summary | |
---|---|
static class |
PlSqlDatatype.Structure |
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject |
---|
AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport |
Field Summary | |
---|---|
static java.lang.String |
TYPE |
Fields inherited from interface oracle.javatools.db.datatypes.DataType |
---|
PCTROWTYPE, PCTTYPE, REF |
Fields inherited from interface oracle.javatools.db.DBObject |
---|
COMMENT |
Constructor Summary | |
---|---|
PlSqlDatatype() |
Method Summary | |
---|---|
void |
addVariable(PlSqlVariable variable) Adds the given PlSqlVariable to the Variables property array |
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. |
DBObjectID |
getBaseTypeID() Get method for the BaseTypeID property |
DataTypeAttribute |
getDataTypeAttribute(java.lang.String name) Gets a DataTypeAttribute of the given name |
DataTypeAttribute[] |
getDataTypeAttributes() Get method for the DataTypeAttributes property |
java.lang.String |
getDDL(DataTypeUsage dataTypeUsage) Generates the DDL for this type. |
java.lang.Integer |
getLimit() Get method for the Limit property |
PlSqlDatatype.Structure |
getStructure() Get method for the Structure property |
java.lang.String |
getType() Returns the type of this object. |
PlSqlVariable[] |
getVariables() Get method for the Variables property |
boolean |
hasDataTypeAttribute(java.lang.String name) Returns true if this DataTYpe has the given attribute name. |
boolean |
isSubType() Get method for the SubType property |
boolean |
matches(java.lang.String usageString) Returns true if the usageString is valid syntax for the DataType, false otherwise. |
void |
setBaseTypeID(DBObjectID baseTypeID) Set method for the BaseTypeID property |
void |
setLimit(java.lang.Integer limit) Set method for the Limit property |
void |
setStructure(PlSqlDatatype.Structure structure) Set method for the Structure property |
void |
setSubType(boolean subType) Set method for the SubType property |
void |
setVariables(PlSqlVariable[] variables) Set method for the Variables property |
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.plsql.DBObjectPlSqlFragment |
---|
clearSourceID, copyToImpl, getChildAtOffset, getEndOffset, getParent, getSourceID, getStartOffset, setEndOffset, setParent, setStartOffset |
Methods inherited from class oracle.javatools.db.AbstractBuildableObject |
---|
checkInit, checkInit, equalsImpl, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDsImpl, needsInitialization, setProperty |
Methods inherited from class oracle.javatools.db.AbstractDBObject |
---|
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperty, getReferenceIDs, 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, getParent, getReferenceIDs, replaceReferenceIDs, setID, setName |
Methods inherited from interface oracle.javatools.util.DynamicPropertySet |
---|
getProperties, getProperty, getProperty, setProperties, setProperty |
Field Detail |
---|
public static final java.lang.String TYPE
Constructor Detail |
---|
public PlSqlDatatype()
Method Detail |
---|
public java.lang.String getType()
DBObject
getType
in interface DBObject
public void setVariables(PlSqlVariable[] variables)
variables
- constituent members of a record datatypepublic PlSqlVariable[] getVariables()
public void addVariable(PlSqlVariable variable)
variable
- member of a record datatypepublic boolean isSubType()
public void setSubType(boolean subType)
public PlSqlDatatype.Structure getStructure()
public void setStructure(PlSqlDatatype.Structure structure)
structure
- indicator of the type of DataTypepublic DBObjectID getBaseTypeID()
public void setBaseTypeID(DBObjectID baseTypeID)
baseTypeID
- the ID of the base datatype for collections such as table and varraypublic java.lang.Integer getLimit()
public void setLimit(java.lang.Integer limit)
limit
- the size of the collection if varraypublic DataTypeAttribute[] getDataTypeAttributes()
getDataTypeAttributes
in interface DataType
public boolean hasDataTypeAttribute(java.lang.String name)
DataType
hasDataTypeAttribute
in interface DataType
public DataTypeAttribute getDataTypeAttribute(java.lang.String name)
getDataTypeAttribute
in interface DataType
public java.lang.String getDDL(DataTypeUsage dataTypeUsage)
DataType
getDDL
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 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 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 void validateUsage(DataTypeUsage dataTypeUsage, DBObject dbObject)
DataType
validateUsage
in interface DataType
dataTypeUsage
- : the usage to be validateddbObject
- : the context of the data type usagepublic void validateDefaultValue(java.lang.Object defaultValue, DataTypeUsage dataTypeUsage, DBObject dbObject)
DataType
validateDefaultValue
in interface DataType
defaultValue
- : the default valuedataTypeUsage
- : the usage to be validateddbObject
- : the context of the data type usage
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |