oracle.javatools.db.plsql

Class PlSqlDatatype

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.plsql.DBObjectPlSqlFragment

oracle.javatools.db.plsql.PlSqlCodeFragment

oracle.javatools.db.plsql.PlSqlDatatype

All Implemented Interfaces:

ChildDBObject, DataType, DBObject, Copyable, DynamicPropertySet

public class PlSqlDatatype
extends PlSqlCodeFragment
implements DataType

Representation of a PL/SQL Datatype such as a record, varray table etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlSqlDatatype.Structure

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
PlSqlDatatype()

Method Summary

Methods

Modifier and Type	Method and Description
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.
PlSqlReference	findBaseTypeReference() Finds the PlSqlReference from the parent PlSqlBlock that represents the base type of this datatype.
DBObjectID	getBaseTypeID() Convenience method to get the DBObjectID for the base type of this datatype.
java.lang.Integer	getBaseTypeOffset() Gets the offset of the base type for this datatype in the source.
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
java.lang.Integer	getSQLType() Gets the SQL type that identifies this data type.
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) Deprecated. set the offset of the PlSqlReference that represents the base type instead using setBaseTypeOffset(Integer).
void	setBaseTypeOffset(java.lang.Integer offset) Sets the offset of the base type for this datatype in the source.
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) Deprecated.
void	validateUsage(DataTypeUsage dataTypeUsage, DBObject dbObject) Deprecated.

Methods inherited from class oracle.javatools.db.plsql.PlSqlCodeFragment

addComment, getComments, setComments

Methods inherited from class oracle.javatools.db.plsql.DBObjectPlSqlFragment

copyToImpl, getChildAtOffset, getDeclarationAtOffset, getEndOffset, getEndToken, getName, getReferenceAtOffset, getSourceID, getStartOffset, getStartToken, setEndOffset, setSourceImpl, setStartOffset

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PlSqlDatatype

public PlSqlDatatype()

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.

Specified by:

getType in interface DBObject

Returns:

a string describing the type of object.

getSQLType

public java.lang.Integer getSQLType()

Description copied from interface: DataType

Gets the SQL type that identifies this data type.

Specified by:

getSQLType in interface DataType

Returns:

a known sql type, or null if the type is not known.

See Also:

Types, OracleTypes

setVariables

public void setVariables(PlSqlVariable[] variables)

Set method for the Variables property

Parameters:

variables - constituent members of a record datatype

Since:

11.1.2.0.0

getVariables

public PlSqlVariable[] getVariables()

Get method for the Variables property

Returns:

constituent members of a record datatype

Since:

11.1.2.0.0

addVariable

public void addVariable(PlSqlVariable variable)

Adds the given PlSqlVariable to the Variables property array

Parameters:

variable - member of a record datatype

Since:

11.1.2.0.0

isSubType

public boolean isSubType()

Get method for the SubType property

Since:

11.1.2.0.0

setSubType

public void setSubType(boolean subType)

Set method for the SubType property

Since:

11.1.2.0.0

getStructure

public PlSqlDatatype.Structure getStructure()

Get method for the Structure property

Returns:

indicator of the type of DataType

Since:

11.1.2.0.0

setStructure

public void setStructure(PlSqlDatatype.Structure structure)

Set method for the Structure property

Parameters:

structure - indicator of the type of DataType

Since:

11.1.2.0.0

getBaseTypeID

public DBObjectID getBaseTypeID()

Convenience method to get the DBObjectID for the base type of this datatype.

Returns:

the ID of the base datatype for collections such as table and varray

Since:

11.1.2.0.0

See Also:

getBaseTypeOffset(), findBaseTypeReference()

setBaseTypeID

@Deprecated
public void setBaseTypeID(DBObjectID baseTypeID)

Deprecated. set the offset of the PlSqlReference that represents the base type instead using setBaseTypeOffset(Integer).

getBaseTypeOffset

public java.lang.Integer getBaseTypeOffset()

Gets the offset of the base type for this datatype in the source.

For example, for type varvarr in the following procedure:

CREATE PROCEDURE PROC1 AS
 TYPE varvarr IS VARRAY(2) of VARCHAR2(10);
 ...

This is the offset of the start of VARCHAR2.

Returns:

the offset of the base type

Since:

12.1.3

setBaseTypeOffset

public void setBaseTypeOffset(java.lang.Integer offset)

Sets the offset of the base type for this datatype in the source.

Parameters:

offset - the base type offset

Since:

12.1.3

findBaseTypeReference

public PlSqlReference findBaseTypeReference()

Finds the PlSqlReference from the parent PlSqlBlock that represents the base type of this datatype.

Returns:

the reference for the base type, or null if the offset is not set, the parent is not a block or no reference can be found at the offset.

See Also:

getBaseTypeOffset()

getLimit

public java.lang.Integer getLimit()

Get method for the Limit property

Returns:

the size of the collection if varray

Since:

11.1.2.0.0

setLimit

public void setLimit(java.lang.Integer limit)

Set method for the Limit property

Parameters:

limit - the size of the collection if varray

Since:

11.1.2.0.0

getDataTypeAttributes

public DataTypeAttribute[] getDataTypeAttributes()

Get method for the DataTypeAttributes property

Specified by:

getDataTypeAttributes in interface DataType

Returns:

Since:

11.1.2.0.0

hasDataTypeAttribute

public boolean hasDataTypeAttribute(java.lang.String name)

Description copied from interface: DataType

Returns true if this DataType has the given attribute name.

Specified by:

hasDataTypeAttribute in interface DataType

Parameters:

name - the name of the attribute to check.

Returns:

true if the DataTypeAttribute corresponding to name exists.

getDataTypeAttribute

public DataTypeAttribute getDataTypeAttribute(java.lang.String name)

Gets a DataTypeAttribute of the given name

Specified by:

getDataTypeAttribute in interface DataType

Parameters:

name - the name of the attribute to get

Returns:

Since:

11.1.2.0.0

getDDL

public java.lang.String getDDL(DataTypeUsage dataTypeUsage)

Description copied from interface: DataType

Generates the DDL for this type. Uses dataTypeUsages's get() methods to get the actual property values.

Specified by:

getDDL in interface DataType

Parameters:

dataTypeUsage - a usage of this type

Returns:

the ddl syntax for the given usage (e.g. to use in the column clause of a create table statement).

createDefaultUsage

public DataTypeUsage createDefaultUsage()

Description copied from interface: DataType

Returns an DataTypeUsage object for this type. Used by UI to create a default data type usage. Mandatory declarable attributes of the data type are initialised with appropriate values.

Specified by:

createDefaultUsage in interface DataType

Returns:

a default usage of this type

createUsage

public DataTypeUsage createUsage(java.util.Map<java.lang.String,java.lang.Object> attributes)

Description copied from interface: DataType

Returns an DataTypeUsage object for this type, populated with attributes. Should be overridden by sub-classes to return an object of the sub-class type.

Specified by:

createUsage in interface DataType

Parameters:

attributes - the attributes for the new usage

Returns:

a new usage of this type with the given attributes

createUsage

public DataTypeUsage createUsage(java.lang.String usageString)

Description copied from interface: DataType

Returns an DataTypeUsage object for this type, populated with attributes based on the usageString. Returns null if the usageString does not match the syntax of the DataType. See DataType.matches(java.lang.String). Should be overridden by sub-classes to return an object of the sub-class type.

Specified by:

createUsage in interface DataType

Parameters:

usageString - the string to use to create a usage

Returns:

a new usage or null if the usageString does not match.

matches

public boolean matches(java.lang.String usageString)

Description copied from interface: DataType

Returns true if the usageString is valid syntax for the DataType, false otherwise. Should be overridden by sub-classes to do the validation.

Specified by:

matches in interface DataType

Parameters:

usageString - the string to match

Returns:

true if the usageString matches this type

validateUsage

@Deprecated
public void validateUsage(DataTypeUsage dataTypeUsage,
                            DBObject dbObject)

Deprecated.

Specified by:

validateUsage in interface DataType

validateDefaultValue

@Deprecated
public void validateDefaultValue(java.lang.Object defaultValue,
                                   DataTypeUsage dataTypeUsage,
                                   DBObject dbObject)

Deprecated.

Specified by:

validateDefaultValue in interface DataType