oracle.javatools.db.plsql

Interface PlSqlSourceObject

All Superinterfaces:

Copyable, DBObject, SchemaObject, SourceObject, SystemObject

All Known Implementing Classes:

Function, Package, PackageBody, PlSqlSchemaObject, PlSqlSchemaObjectBody, PlSqlSchemaObjectSpec, Procedure, Trigger, Type, TypeBody

public interface PlSqlSourceObject
extends SourceObject

A PL/SQL Schema Object.

Since:

12.1.3

Field Summary

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Method Summary

Modifier and Type	Method and Description
PlSqlBlock[]	getBlocks() Deprecated. Use getStatements()
DBObjectPlSqlFragment	getChildAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject.
PlSqlComment[]	getComments() Get any child PlSqlComments.
PlSqlDatatype[]	getDatatypes() Get any child PlSqlDatatypes.
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 the end offset of this PlSqlSourceObject (one less than the length of the source).
DBObjectPlSqlFragment	getReferenceAtOffset(int offset) Find a child DBObjectPlSqlFragment at the given offset in the source of the parent PlSqlSourceObject that is a PlSqlReference.
PlSqlReference[]	getReferences() Get any child PlSqlReferences.
java.lang.String	getSource() Get the source of the PlSqlSourceObject.
java.lang.Integer	getStartOffset() Get the start offset of this PlSqlSourceObject (always zero).
PlSqlStatement[]	getStatements() Get any child PlSqlStatements.
PlSqlSubProgram[]	getSubPrograms() Get any child PlSqlSubPrograms.
PlSqlVariable[]	getVariables() Get any child PlSqlVariables.

Methods inherited from interface oracle.javatools.db.SourceObject

setSource

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

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperties, getProperty, getProperty, getReferenceIDs, getType, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Method Detail

getChildAtOffset

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

getDeclarationAtOffset

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

getReferenceAtOffset

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 PlSqlReference at the given offset, or null.

Throws:

CancelledException

getEndOffset

java.lang.Integer getEndOffset()

Get the end offset of this PlSqlSourceObject (one less than the length of the source).

getStartOffset

java.lang.Integer getStartOffset()

Get the start offset of this PlSqlSourceObject (always zero).

getStatements

PlSqlStatement[] getStatements()

Get any child PlSqlStatements.

getComments

PlSqlComment[] getComments()

Get any child PlSqlComments.

getDatatypes

PlSqlDatatype[] getDatatypes()

Get any child PlSqlDatatypes.

getReferences

PlSqlReference[] getReferences()

Get any child PlSqlReferences.

getSubPrograms

PlSqlSubProgram[] getSubPrograms()

Get any child PlSqlSubPrograms.

getVariables

PlSqlVariable[] getVariables()

Get any child PlSqlVariables.

getSource

java.lang.String getSource()

Get the source of the PlSqlSourceObject.

Specified by:

getSource in interface SourceObject

getBlocks

@Deprecated
PlSqlBlock[] getBlocks()

Deprecated. Use getStatements()