oracle.javatools.db.plsql

Class DBObjectPlSqlFragment

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.plsql.DBObjectPlSqlFragment

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable

Direct Known Subclasses:

PlSqlCodeFragment, PlSqlComment, PlSqlReference

public abstract class DBObjectPlSqlFragment
extends AbstractChildBuildableObject

Top-most PL/SQL specific superclass of all PL/SQL DBObject classes in this package. A DBObjectPlSqlFragment represents anything from a complete schema object such as a Procedure,Function or Package; a PlSqlBlock, PlSqlVariable or PlSqlParameter right down to a PlSqlReference (which is just a reference to some other object from within PL/SQL).

Nested Class Summary

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

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
DBObjectPlSqlFragment	getChildAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject.
DBObjectPlSqlFragment	getDeclarationAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject that is not a PlSqlReference.
java.lang.Integer	getEndOffset() Get method for the EndOffset property
java.lang.String	getName() Retrieves the name of this object.
DBObjectPlSqlFragment	getReferenceAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject that is a PlSqlReference.
java.lang.String	getSource() Get method for the internal source property.
java.lang.String	getSourceID()
java.lang.Integer	getStartOffset() Get method for the StartOffset property
void	setEndOffset(java.lang.Integer end) Set method for the EndOffset property
void	setSource(java.lang.String source) Calling this method will result in an UnsupportedOperationException as setting source on a child object is not supported.
protected void	setSourceImpl(java.lang.String source)
void	setStartOffset(java.lang.Integer start) Set method for the StartOffset property

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID

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, getChildSupport, getID, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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, findOwnedObject, getID, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, getType, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Constructor Detail

DBObjectPlSqlFragment

public DBObjectPlSqlFragment()

DBObjectPlSqlFragment

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

Method Detail

getStartOffset

public java.lang.Integer getStartOffset()

Get method for the StartOffset property

Returns:

the start offset of this DBObjectPlSqlFragment within the source of the parent PlSqlSourceObject.

Since:

11.1.2.0.0

setStartOffset

public void setStartOffset(java.lang.Integer start)

Set method for the StartOffset property

Parameters:

start - the start offset of this DBObjectPlSqlFragment within the source of the parent PlSqlSourceObject.

Since:

11.1.2.0.0

getEndOffset

public java.lang.Integer getEndOffset()

Get method for the EndOffset property

Returns:

the end offset of this DBObjectPlSqlFragment within the source of the parent PlSqlSourceObject.

Since:

11.1.2.0.0

setEndOffset

public void setEndOffset(java.lang.Integer end)

Set method for the EndOffset property

Parameters:

end - the end offset of this DBObjectPlSqlFragment within the source of the parent PlSqlSourceObject.

Since:

11.1.2.0.0

getChildAtOffset

public DBObjectPlSqlFragment getChildAtOffset(int offset)
                                       throws CancelledException

Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject. If a reference and a declaration are found at the same location, the the reference will be returned. See getDeclarationAtOffset(int) and See getReferenceAtOffset(int).

Parameters:

offset - Offset in the source of the parent PlSqlSourceObject

Returns:

Child DBObjectPlSqlFragment at the given offset, or null.

Throws:

CancelledException

Since:

11.1.2.0.0

getDeclarationAtOffset

public DBObjectPlSqlFragment getDeclarationAtOffset(int offset)
                                             throws CancelledException

Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject that is not a PlSqlReference.

Parameters:

offset - Offset in the source of the parent PlSqlSourceObject

Returns:

Child DBObjectPlSqlFragment at the given offset, or null.

Throws:

CancelledException

Since:

12.1.2.0.0

getReferenceAtOffset

public DBObjectPlSqlFragment getReferenceAtOffset(int offset)
                                           throws CancelledException

Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject that is a PlSqlReference.

Parameters:

offset - Offset in the source of the parent PlSqlSourceObject

Returns:

Child DBObjectPlSqlFragment at the given offset, or null.

Throws:

CancelledException

Since:

12.1.2.0.0

getSourceID

public java.lang.String getSourceID()

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 AbstractBuildableObject

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.

getName

public java.lang.String getName()

Description copied from interface: DBObject

Retrieves the name of this object.

Specified by:

getName in interface DBObject

Overrides:

getName in class AbstractDBObject

Returns:

a string containing the name of this object.

setSourceImpl

protected void setSourceImpl(java.lang.String source)

getSource

public java.lang.String getSource()

Get method for the internal source property. Child PL/SQL objects that subclass this and have derived properties will have this property as the source property for all derived properties. Calling getSource() will traverse the parent hierarchy to the top level PlSqlSourceObject and then use the fragments start and end offsets as arguments to substring on the (non transient) source property of that object.

Returns:

The substring of the source of the top level PlSqlSourceObject represented by this fragment.

setSource

public void setSource(java.lang.String source)

Calling this method will result in an UnsupportedOperationException as setting source on a child object is not supported.