PlSqlInterrogator (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- 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.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancelCurrentBuild()` If this PlSqlInterrogator is currently interrogating the PLSQL to build the tree of PlSqlFragments this will cause that process to be cancelled.
`boolean`	`containsToDo()`
`int`	`findExecutableLineNumber(java.lang.String signature)` Returns the line number of the first executable line in the procedure or function identified by the signature.
`java.util.List<PlSqlFragment>`	`findFragmentsBySignature(java.lang.String signature)` Returns a list of PlSqlFragments representing procedures or functions matching the given signature.
`static PlSqlInterrogator`	`findOrCreate(java.lang.String source)` Return a PlSqlInterrogator for the given source.
`static PlSqlInterrogator`	`findOrCreate(java.lang.String key, java.lang.String source)` Return a PlSqlInterrogator for the given source.
`static PlSqlInterrogator`	`findOrCreate(java.lang.String key, java.lang.String source, Holder<PlSqlInterrogator> holder)` Return a PlSqlInterrogator for the given source.
`java.lang.String`	`getCollectionType()`
`java.util.List<java.lang.String>`	`getExternalDeclarations()` Deprecated.
`PlSqlFragment`	`getFragmentAtOffset(int offset)`
`int`	`getLineNumber(int offset)`
`java.util.List<java.lang.Integer>`	`getLocationOffsets(java.lang.String text)` Finds the offsets in the original source for tokens matching the given text.
`int`	`getMatchingOffset(int offset)`
`java.lang.String`	`getName()`
`int`	`getNameOffset()`
`PlsqlError[]`	`getPlSqlErrors()` Deprecated. Use PlSqlParserHelper.getIssues(String text) instead.
`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()` Deprecated. Use PlSqlParserHelper.getIssues(String text), and check !list.isEmpty() instead.
`boolean`	`isCurrentBuildCancelled()` Has the building of PlSqlFragments for tyhis PlSqlInterrogator been cancelled.
`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

- Method Detail
  - findOrCreate
```
public static PlSqlInterrogator findOrCreate(java.lang.String source)
```
    Return a PlSqlInterrogator for the given source. If there is a PlSqlInterrogator already cached for the source, it will be returned, otherwise a new PlSqlInterrogator will be created, and the source parsed into PlSqlTokens and PlSqlFragments.
    If the thread is interruped while parsing, processing will stop and a PlSqlInterrogator with only basic properties defined (and no PlSqlFragment tree) will be returned. The interrupt status of the current thread will remain set and #isThreadInterrupted will return true.
    
    Parameters:
    source - PL/SQL source code.
    
    Returns:
    a PlSqlInterrogator that will provide information about the given source
  - findOrCreate
```
public static PlSqlInterrogator findOrCreate(java.lang.String key,
                             java.lang.String source)
```
    Return a PlSqlInterrogator for the given source. If there is a PlSqlInterrogator already cached for the key, it will be returned, otherwise a new PlSqlInterrogator will be created, and the source parsed into PlSqlTokens and PlSqlFragments.
    If the thread is interruped while parsing, processing will stop and a PlSqlInterrogator with only basic properties defined (and no PlSqlFragment tree) will be returned. The interrupt status of the current thread will remain set and #isThreadInterrupted will return true.
    Note: It is the callers responsibility to ensure a 1:1 mapping between key and source.
    
    Parameters:
    key - a unique key to identify a cached PlSqlInterrogator
    source - PL/SQL source code.
    
    Returns:
    a PlSqlInterrogator that will provide information about the given source
  - findOrCreate
```
public static PlSqlInterrogator findOrCreate(java.lang.String key,
                             java.lang.String source,
                             Holder<PlSqlInterrogator> holder)
```
    Return a PlSqlInterrogator for the given source. If there is a PlSqlInterrogator already cached for the key, it will be returned, otherwise a new PlSqlInterrogator will be created, and the source parsed into PlSqlTokens and PlSqlFragments.
    If the thread is interruped while parsing, processing will stop and a PlSqlInterrogator with only basic properties defined (and no PlSqlFragment tree) will be returned. The interrupt status of the current thread will remain set and #isThreadInterrupted will return true.
    Note: It is the callers responsibility to ensure a 1:1 mapping between key and source.
    
    Parameters:
    key - a unique key to identify a cached PlSqlInterrogator
    source - PL/SQL source code.
    holder - A Holder object into which the PlSqlInterrogator will be placed before the interrogation starts.
    
    Returns:
    a PlSqlInterrogator that will provide information about the given 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.
  - cancelCurrentBuild
```
public void cancelCurrentBuild()
```
    If this PlSqlInterrogator is currently interrogating the PLSQL to build the tree of PlSqlFragments this will cause that process to be cancelled.
  - isCurrentBuildCancelled
```
public boolean isCurrentBuildCancelled()
```
    Has the building of PlSqlFragments for tyhis PlSqlInterrogator been cancelled.
  - 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
  - getNameOffset
```
public int getNameOffset()
```
    Returns:
    The offset of the name of the object
  - 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
```
@Deprecated
public PlsqlError[] getPlSqlErrors()
```
    Deprecated. Use PlSqlParserHelper.getIssues(String text) instead.
  - hasParseErrors
```
@Deprecated
public boolean hasParseErrors()
```
    Deprecated. Use PlSqlParserHelper.getIssues(String text), and check !list.isEmpty() instead.
  - 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)
```
  - findExecutableLineNumber
```
public int findExecutableLineNumber(java.lang.String signature)
```
    Returns the line number of the first executable line in the procedure or function identified by the signature. If more than one procedure or function match the signature the first will be used.
    
    Parameters:
    signature - See findFragmentsBySignature(java.lang.String) for details.
    
    Returns:
    line number, or zero if no match found
  - getMatchingOffset
```
public int getMatchingOffset(int offset)
```
  - findFragmentsBySignature
```
public java.util.List<PlSqlFragment> findFragmentsBySignature(java.lang.String signature)
```
    Returns a list of PlSqlFragments representing procedures or functions matching the given signature. The signature must be of the following form:
    - <name> - matches procedures and/or functions of the given name
    - <name>([[<paramName>=>]<paramDataType>,]...):[<returnType>] - matches procedures and/or functions (or just functions if the returnType is given) with paramteres of the given paramDataTypes, and optionally of the given paramNames
    The following are all examples of valid signatures:
    - my_method
    - my_function:number
    - getEmployeeName(number):varchar2
    - getEmployeeID(name=>varchar2,dept=>varchar2):number
    - myZeroArgMethod()
  - getExternalDeclarations
```
@Deprecated
public java.util.List<java.lang.String> getExternalDeclarations()
```
    Deprecated.
  - getLocationOffsets
```
public java.util.List<java.lang.Integer> getLocationOffsets(java.lang.String text)
```
    Finds the offsets in the original source for tokens matching the given text. This is desgned to find plsql tokens only, so any comments, string or numeric literals etc will be ignored. If the case of the input argument is not upper then only double quoted strings continaing text will match.

Class PlSqlInterrogator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

findOrCreate

findOrCreate

findOrCreate

getPlSqlIdentifier

getPlSqlIdentifier

cancelCurrentBuild

isCurrentBuildCancelled

getRoot

getType

getSchemaName

getName

getNameOffset

getTypeCode

getCollectionType

isWrapped

getLineNumber

getFragmentAtOffset

getTokenAtOffset

getPlSqlErrors

hasParseErrors

containsToDo

getRenamedSource

getRenamedSource

isEvolvedType

getUpdatedSourceForRelationRename

getSource

skipToCodeToken

findExecutableLineNumber

getMatchingOffset

findFragmentsBySignature

getExternalDeclarations

getLocationOffsets