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, DynamicPropertySet

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

Methods

Modifier and Type	Method and Description
protected void	clearSourceID()
protected void	copyToImpl(AbstractDBObject copy, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
protected void	fireObjectUpdated(DBObjectChange change)
DBObjectPlSqlFragment	getChildAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent SourceObject.
DBObjectPlSqlFragment	getDeclarationAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent SourceObject that is not a PlSqlReference.
java.lang.Integer	getEndOffset() Get method for the EndOffset property
DBObjectPlSqlFragment	getReferenceAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent SourceObject that is a PlSqlReference.
java.lang.String	getSourceID()
java.lang.Integer	getStartOffset() Get method for the StartOffset property
protected boolean	isBuilt()
void	setEndOffset(java.lang.Integer end) Set method for the EndOffset property
void	setName(java.lang.String name) Set name of the fragment.
protected void	setSourceImpl(java.lang.String source, boolean clearDerived)
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, equalsImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

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

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, 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 SourceObject.

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

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

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

Since:

11.1.2.0.0

getChildAtOffset

public DBObjectPlSqlFragment getChildAtOffset(int offset)

Find a child DBObjectPlSqlFragment at the given offset in the source of the parent SourceObject. 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 SourceObject

Returns:

Child DBObjectPlSqlFragment at the given offset, or null.

Since:

11.1.2.0.0

getDeclarationAtOffset

public DBObjectPlSqlFragment getDeclarationAtOffset(int offset)

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

Parameters:

offset - Offset in the source of the parent SourceObject

Returns:

Child DBObjectPlSqlFragment at the given offset, or null.

Since:

12.1.2.0.0

getReferenceAtOffset

public DBObjectPlSqlFragment getReferenceAtOffset(int offset)

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

Parameters:

offset - Offset in the source of the parent SourceObject

Returns:

Child DBObjectPlSqlFragment at the given offset, or null.

Since:

12.1.2.0.0

getSourceID

public java.lang.String getSourceID()

clearSourceID

protected void clearSourceID()

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.

setName

public void setName(java.lang.String name)

Set name of the fragment. If this is a declaration such as a variable or parameter of a fully built SourceObject, the source will be updated to reflect the name change.

Specified by:

setName in interface DBObject

Overrides:

setName in class AbstractDBObject

Parameters:

name -

fireObjectUpdated

protected void fireObjectUpdated(DBObjectChange change)

Overrides:

fireObjectUpdated in class AbstractBuildableObject

isBuilt

protected boolean isBuilt()

setSourceImpl

protected void setSourceImpl(java.lang.String source,
                 boolean clearDerived)