oracle.javatools.db
Class SpecPlSql

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractBuildableObject
          oracle.javatools.db.AbstractSystemObject
              oracle.javatools.db.AbstractSchemaObject
                  oracle.javatools.db.PlSql
                      oracle.javatools.db.SpecPlSql

All Implemented Interfaces:

DBObject, SchemaObject, SourceObject, SystemObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

ComplexType, Package

public abstract class SpecPlSql
extends PlSql

Extension of PlSql for objects that have a spec and body. The spec can be declaratively represented by methods and attributes.

Since:

10.1.3

Nested Class Summary

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

AbstractDBObject.ChildSupport

Field Summary

Fields inherited from class oracle.javatools.db.PlSql

BLOCK_TYPE

Fields inherited from class oracle.javatools.db.AbstractSystemObject

m_listeners

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

protected	SpecPlSql()
protected	SpecPlSql(java.lang.String name, Schema schema)

Method Summary

void	addAttribute(int index, PlSqlAttribute att) Adds one attribute to this object type at the given index.
void	addAttribute(PlSqlAttribute att) Adds one attribute to this object type.
void	addMethod(int index, PlSqlMethod method) Adds one method to this object type at the given index.
void	addMethod(PlSqlMethod method) Adds one method to this object type.
protected void	copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
protected boolean	equalsImpl(AbstractDBObject target) Equals implementation for testing equality with another AbstractDBObject.
PlSqlAttribute	getAttribute(java.lang.String name) Retrieves one attribute by name.
PlSqlAttribute[]	getAttributes() Retrieves the list of attributes contained in this object type.
java.lang.String	getBodySource()
PlSqlInterrogator	getBodySourceInterrogator()
PlSqlMethod	getMethod(java.lang.String name) Retrieves one method by name.
PlSqlMethod[]	getMethods() Retrieves the list of methods contained in this object type.
void	removeAttribute(PlSqlAttribute att) Removes an attribute from this object type.
void	removeMethod(PlSqlMethod method) Removes an method from this object type.
void	setAttributes(PlSqlAttribute[] newAttribs) Sets the entire list of attributes, replacing any that have previously been added.
void	setBodySource(java.lang.String body)
void	setMethods(PlSqlMethod[] newMethods) Sets the entire list of methods, replacing any that have previously been added.

Methods inherited from class oracle.javatools.db.PlSql

getSource, getSourceInterrogator, isPlSql, setSource

Methods inherited from class oracle.javatools.db.AbstractSchemaObject

addObjectListener, getProperty, getSchema, removeObjectListener, setProperty, setSchema

Methods inherited from class oracle.javatools.db.AbstractSystemObject

addObjectListener, fireObjectUpdated, getParent, removeObjectListener

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

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

addObjectListener, getSchema, removeObjectListener, setSchema

Methods inherited from interface oracle.javatools.db.SystemObject

addObjectListener, fireObjectUpdated, removeObjectListener

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getReferenceIDs, getType, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Constructor Detail

SpecPlSql

protected SpecPlSql()

SpecPlSql

protected SpecPlSql(java.lang.String name,
                    Schema schema)

Method Detail

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 PlSql

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.

equalsImpl

protected boolean equalsImpl(AbstractDBObject target)

Description copied from class: AbstractDBObject

Equals implementation for testing equality with another AbstractDBObject. Override this method (with exact signature) to customise the equality comparison.

Overrides:

equalsImpl in class PlSql

setAttributes

public void setAttributes(PlSqlAttribute[] newAttribs)

Sets the entire list of attributes, replacing any that have previously been added. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

newAttribs - an array containing the new list of attributes

getAttributes

public PlSqlAttribute[] getAttributes()

Retrieves the list of attributes contained in this object type. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Returns:

an array containing the list of attributes

addAttribute

public void addAttribute(PlSqlAttribute att)

Adds one attribute to this object type. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

att - the new attribute to add

addAttribute

public void addAttribute(int index,
                         PlSqlAttribute att)

Adds one attribute to this object type at the given index. Shift the attribute at that position (and any subsequent attributes) down one place. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

index - the index to add the new attribute at

att - the new attribute to add

getAttribute

public PlSqlAttribute getAttribute(java.lang.String name)

Retrieves one attribute by name.

Parameters:

a - string containing the desired attribute name

Returns:

The attribute requested or null

removeAttribute

public void removeAttribute(PlSqlAttribute att)

Removes an attribute from this object type. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

att - the attribute to remove

setMethods

public void setMethods(PlSqlMethod[] newMethods)

Sets the entire list of methods, replacing any that have previously been added. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

newMethods - an array containing the new list of methods

getMethods

public PlSqlMethod[] getMethods()

Retrieves the list of methods contained in this object type.

Returns:

an array containing the list of methods

addMethod

public void addMethod(PlSqlMethod method)

Adds one method to this object type. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

att - the new method to add

addMethod

public void addMethod(int index,
                      PlSqlMethod method)

Adds one method to this object type at the given index. Shift the method at that position (and any subsequent methods) down one place. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

index - the index to add the new method at

method - the new method to add

getMethod

public PlSqlMethod getMethod(java.lang.String name)

Retrieves one method by name.

Parameters:

a - string containing the desired method name

Returns:

The method requested or null

removeMethod

public void removeMethod(PlSqlMethod method)

Removes an method from this object type. This method does not update the underlying PL/SQL. It is only intended to be used at build time by the Object Type Builder.

Parameters:

method - the method to remove

getBodySource

public java.lang.String getBodySource()

setBodySource

public void setBodySource(java.lang.String body)

getBodySourceInterrogator

public PlSqlInterrogator getBodySourceInterrogator()