oracle.javatools.db.plsql

Class PlSqlBlock

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

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

PlSqlSchemaObject, PlSqlSubProgram

public class PlSqlBlock
extends PlSqlCodeFragment

When instantiated as a concrete class, this represents a PL/SQL Block. However it also acts as a generic superclass for any PL/SQL object that may contain declarations of variables, sub programs and datatypes, and references to other objects. As such it is in the class hierarchy of PlSqlSubProgram and all the SchemaObject types: Procedure, Function, Package, PackageBody, Type, TypeBody and Trigger.

Nested Class Summary

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

COMMENT

Constructor Summary

Constructors

Constructor and Description
PlSqlBlock()
PlSqlBlock(java.lang.String name, DBObject parent)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(PlSqlBlock block) Adds the given PlSqlBlock to the Blocks property array
void	addDatatype(PlSqlDatatype datatype) Adds the given PlSqlDatatype to the Datatypes property array
void	addReference(PlSqlReference reference) Adds the given PlSqlReference to the References property array
void	addSubProgram(PlSqlSubProgram subProgram) Adds the given PlSqlSubProgram to the SubPrograms property array
void	addVariable(PlSqlVariable variable) Adds the given PlSqlVariable to the Variables property array
DBObject	findOwnedObject(DBObjectID id, boolean strict) Returns a child of this object that has the given ID.
PlSqlBlock[]	getBlocks() Get method for the Blocks property
PlSqlDatatype[]	getDatatypes() Get method for the Datatypes property
PlSqlReference[]	getReferences() Get method for the References property
PlSqlSubProgram	getSubProgram(java.lang.String name) Gets a SubProgram of the given name
PlSqlSubProgram[]	getSubPrograms() Get method for the SubPrograms property
java.lang.String	getType() Returns the type of this object.
PlSqlVariable	getVariable(java.lang.String name) Gets a Variable of the given name
PlSqlVariable[]	getVariables() Get method for the Variables property
void	setBlocks(PlSqlBlock[] blocks) Set method for the Blocks property
void	setDatatypes(PlSqlDatatype[] datatypes) Set method for the Datatypes property
void	setReferences(PlSqlReference[] refs) Set method for the References property
void	setSubPrograms(PlSqlSubProgram[] subPrograms) Set method for the SubPrograms property
void	setVariables(PlSqlVariable[] variables) Set method for the Variables property

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, 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.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

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

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PlSqlBlock

public PlSqlBlock()

PlSqlBlock

public PlSqlBlock(java.lang.String name,
          DBObject parent)

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.

setBlocks

public void setBlocks(PlSqlBlock[] blocks)

Set method for the Blocks property

Parameters:

blocks - any child PlSqlBlock's

Since:

11.1.2.0.0

getBlocks

public PlSqlBlock[] getBlocks()

Get method for the Blocks property

Returns:

any child PlSqlBlock's

Since:

11.1.2.0.0

addBlock

public void addBlock(PlSqlBlock block)

Adds the given PlSqlBlock to the Blocks property array

Parameters:

block -

Since:

11.1.2.0.0

setReferences

public void setReferences(PlSqlReference[] refs)

Set method for the References property

Parameters:

refs - references to other objects from within this PlSqlBlock

Since:

11.1.2.0.0

getReferences

public PlSqlReference[] getReferences()

Get method for the References property

Returns:

references to other objects from within this PlSqlBlock

Since:

11.1.2.0.0

addReference

public void addReference(PlSqlReference reference)

Adds the given PlSqlReference to the References property array

Parameters:

reference - reference to an object from within this PlSqlBlock

Since:

11.1.2.0.0

setVariables

public void setVariables(PlSqlVariable[] variables)

Set method for the Variables property

Parameters:

variables - Variables defined within this PlSqlBlock

Since:

11.1.2.0.0

getVariables

public PlSqlVariable[] getVariables()

Get method for the Variables property

Returns:

Variables defined within this PlSqlBlock

Since:

11.1.2.0.0

getVariable

public PlSqlVariable getVariable(java.lang.String name)

Gets a Variable of the given name

Returns:

Variable of the given name defined within this PlSqlBlock, or null

Since:

11.1.2.0.0

addVariable

public void addVariable(PlSqlVariable variable)

Adds the given PlSqlVariable to the Variables property array

Parameters:

variable - Variables defined within this PlSqlBlock

Since:

11.1.2.0.0

setSubPrograms

public void setSubPrograms(PlSqlSubProgram[] subPrograms)

Set method for the SubPrograms property

Parameters:

subPrograms - SubPrograms (procedures and functions) defined within this PlSqlBlock

Since:

11.1.2.0.0

getSubPrograms

public PlSqlSubProgram[] getSubPrograms()

Get method for the SubPrograms property

Returns:

SubPrograms (procedures and functions) defined within this PlSqlBlock

Since:

11.1.2.0.0

getSubProgram

public PlSqlSubProgram getSubProgram(java.lang.String name)

Gets a SubProgram of the given name

Returns:

SubProgram (procedure or function) of the given name defined within this PlSqlBlock, or null

Since:

11.1.2.0.0

addSubProgram

public void addSubProgram(PlSqlSubProgram subProgram)

Adds the given PlSqlSubProgram to the SubPrograms property array

Parameters:

subProgram - SubProgram (procedure or function) of the given name defined within this PlSqlBlock

Since:

11.1.2.0.0

setDatatypes

public void setDatatypes(PlSqlDatatype[] datatypes)

Set method for the Datatypes property

Parameters:

datatypes - DataTypes defined within this PlSqlBlock

Since:

11.1.2.0.0

getDatatypes

public PlSqlDatatype[] getDatatypes()

Get method for the Datatypes property

Returns:

DataTypes defined within this PlSqlBlock

Since:

11.1.2.0.0

addDatatype

public void addDatatype(PlSqlDatatype datatype)

Adds the given PlSqlDatatype to the Datatypes property array

Parameters:

datatype - DataType defined within this PlSqlBlock

Since:

11.1.2.0.0

findOwnedObject

public DBObject findOwnedObject(DBObjectID id,
                       boolean strict)

Description copied from interface: DBObject

Returns a child of this object that has the given ID. The child is located by comparing IDs, not by calling resolveID() and is therefore the quickest way to locate a DBObject if you know its parent.

Note: an unstrict comparison can be time consuming, only request it if you need it (i.e. you are searching using a DBObjectID that did not originate in this object's heirarchy).

The method does not recurse to look for children of children.

This will not find SchemaObjects in a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Specified by:

findOwnedObject in interface DBObject

Overrides:

findOwnedObject in class AbstractDBObject

Parameters:

id - the id to look for

strict - whether to stricly compare IDs or not

Returns:

a child object found with a matching id, or null if no child is found

See Also:

DBObjectID.equals(DBObjectID,boolean)