Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

oracle.javatools.db.plsql
Class PlSqlInterrogator

java.lang.Object
  extended by oracle.javatools.db.plsql.PlSqlInterrogator

public class PlSqlInterrogator
extends java.lang.Object

The PL/SQL Interrogator provides a structured model of PL/SQL source, User Defined Types and Trigger definitions.


Constructor Summary
PlSqlInterrogator(java.lang.String source)
          Deprecated. use factory method findOrCreate(java.lang.String) instead.
 
Method Summary
 boolean containsToDo()
           
static PlSqlInterrogator findOrCreate(java.lang.String source)
           
 java.lang.String getCollectionType()
           
 PlSqlFragment getFragmentAtOffset(int offset)
           
 int getLineNumber(int offset)
           
 java.lang.String getName()
           
 PlsqlError[] getPlSqlErrors()
           
 PlSqlIdentifier getPlSqlIdentifier(java.lang.String schemaName)
          Returns a PlSqlIdentifier derived from the PL/SQL in source.
 PlSqlIdentifier getPlSqlIdentifier(java.lang.String schemaName, boolean force)
          Returns a PlSqlIdentifier derived from the PL/SQL in source.
 java.lang.String getRenamedSource(java.lang.String newName)
           
 java.lang.String getRenamedSource(java.lang.String newName, boolean includeSchema)
           
 PlSqlFragment getRoot()
           
 java.lang.String getSchemaName()
           
 java.lang.String getSource(PlSqlToken start, PlSqlToken end)
           
 PlSqlToken getTokenAtOffset(int offset)
           
 java.lang.String getType()
           
 java.lang.String getTypeCode()
           
 java.lang.String getUpdatedSourceForRelationRename(java.lang.String newRelationName)
           
 boolean hasParseErrors()
           
 boolean isEvolvedType()
           
 boolean isWrapped()
           
 PlSqlToken skipToCodeToken(PlSqlFragment frag, PlSqlToken tk, java.lang.String... tkStrs)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlSqlInterrogator

public PlSqlInterrogator(java.lang.String source)
Deprecated. use factory method findOrCreate(java.lang.String) instead.

Method Detail

findOrCreate

public static PlSqlInterrogator findOrCreate(java.lang.String source)

getPlSqlIdentifier

public PlSqlIdentifier getPlSqlIdentifier(java.lang.String schemaName)
Returns a PlSqlIdentifier derived from the PL/SQL in source. The schema of the PlSqlIdentifier will be schemaName if not explicitly defined in the source.


getPlSqlIdentifier

public PlSqlIdentifier getPlSqlIdentifier(java.lang.String schemaName,
                                          boolean force)
Returns a PlSqlIdentifier derived from the PL/SQL in source. The schema of the PlSqlIdentifier will be schemaName if not explicitly defined in the source, or if force == true.


getRoot

public PlSqlFragment getRoot()
Returns:
The root PlSqlFragment representing the entire PL/SQL source.

getType

public java.lang.String getType()
Returns:
The type of the object created by the PL/SQL source, eg PACKAGE, FUNCTION, TRIGGER

getSchemaName

public java.lang.String getSchemaName()
Returns:
The name of the object's schema created by the PL/SQL source if defined. null othewise.

getName

public java.lang.String getName()
Returns:
The name of the object created by the PL/SQL source

getTypeCode

public java.lang.String getTypeCode()
Returns:
The type code (OBJECT/COLLECTION) of the object created by the PL/SQL source

getCollectionType

public java.lang.String getCollectionType()
Returns:
The collection type (TABLE/VARING ARRAY) of the object created by the PL/SQL source

isWrapped

public boolean isWrapped()
Returns:
is the source wrapped

getLineNumber

public int getLineNumber(int offset)

getFragmentAtOffset

public PlSqlFragment getFragmentAtOffset(int offset)

getTokenAtOffset

public PlSqlToken getTokenAtOffset(int offset)

getPlSqlErrors

public PlsqlError[] getPlSqlErrors()

hasParseErrors

public boolean hasParseErrors()

containsToDo

public boolean containsToDo()

getRenamedSource

public java.lang.String getRenamedSource(java.lang.String newName)

getRenamedSource

public java.lang.String getRenamedSource(java.lang.String newName,
                                         boolean includeSchema)

isEvolvedType

public boolean isEvolvedType()

getUpdatedSourceForRelationRename

public java.lang.String getUpdatedSourceForRelationRename(java.lang.String newRelationName)

getSource

public java.lang.String getSource(PlSqlToken start,
                                  PlSqlToken end)

skipToCodeToken

public PlSqlToken skipToCodeToken(PlSqlFragment frag,
                                  PlSqlToken tk,
                                  java.lang.String... tkStrs)

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

Copyright © 1997, 2011, Oracle. All rights reserved.