oracle.javatools.db.plsql
Class PlSqlReference

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractBuildableObject
          oracle.javatools.db.plsql.DBObjectPlSqlFragment
              oracle.javatools.db.plsql.PlSqlReference

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class PlSqlReference
extends DBObjectPlSqlFragment

A reference from some PL/SQL to another DBObject. Optionally, this may be a DataTypeUsage (with its DataTypeAttributes). A reference may be one of four ReferenceType's:

• DIRECT (eg var := 1; // var is a reference to a local variable)
• REF (eg geom_ref REF MDSYS.SDO_GEOMETRY;)
• PCT_TYPE (eg l_empno EMPLOYEES.EMPNO%TYPE;)
• PCT_ROWTYPE (eg l_empRec EMPLOYEES%ROWTYPE;)

Nested Class Summary

static class

PlSqlReference.ReferenceType

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.DBObject

COMMENT

Constructor Summary

PlSqlReference()

Method Summary

protected void	copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
DataTypeUsage	getDataTypeUsage() Get method for the DataTypeUsage property
DBObjectID	getReferenceID() Get method for the ReferenceID property
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl().
PlSqlReference.ReferenceType	getReferenceType() Get method for the ReferenceType property
java.lang.String	getType() Returns the type of this object.
void	setDataTypeUsage(DataTypeUsage dataTypeUsage) Set method for the DataTypeUsage property
void	setReferenceID(DBObjectID referenceID) Set method for the ReferenceID property
void	setReferenceType(PlSqlReference.ReferenceType referenceType) Set method for the ReferenceType property

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

clearSourceID, getChildAtOffset, getEndOffset, getParent, getSourceID, getStartOffset, setEndOffset, setParent, setStartOffset

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, equalsImpl, getOwnedObjectsImpl, getProperties, getProperty, 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, getReferenceIDs, replaceReferenceIDs, 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

Constructor Detail

PlSqlReference

public PlSqlReference()

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.

Returns:

a string describing the type of object.

setReferenceID

public void setReferenceID(DBObjectID referenceID)

Set method for the ReferenceID property

Parameters:

referenceID -

Since:

11.1.2.0.0

getReferenceID

public DBObjectID getReferenceID()

Get method for the ReferenceID property

Returns:

Since:

11.1.2.0.0

setReferenceType

public void setReferenceType(PlSqlReference.ReferenceType referenceType)

Set method for the ReferenceType property

Parameters:

referenceType -

Since:

11.1.2.0.0

getReferenceType

public PlSqlReference.ReferenceType getReferenceType()

Get method for the ReferenceType property

Returns:

Since:

11.1.2.0.0

setDataTypeUsage

public void setDataTypeUsage(DataTypeUsage dataTypeUsage)

Set method for the DataTypeUsage property

Parameters:

dataTypeUsage -

Since:

11.1.2.0.0

getDataTypeUsage

public DataTypeUsage getDataTypeUsage()

Get method for the DataTypeUsage property

Returns:

Since:

11.1.2.0.0

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)

Description copied from class: AbstractBuildableObject

Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl(). All overrides must call this first to ensure the object has been built.

Overrides:

getReferenceIDsImpl in class AbstractBuildableObject

Parameters:

refs - the collection of ids this object references

copyToImpl

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

Description copied from class: AbstractDBObject

Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.

Overrides:

copyToImpl in class DBObjectPlSqlFragment

Parameters:

copy - the copy being created of this object

copyParent - if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.

idPolicy - the policy for copying the object's ID.