PLSQLParser (PMD PL/SQL 5.4.1 API)

java.lang.Object
- net.sourceforge.pmd.lang.plsql.ast.PLSQLParser

All Implemented Interfaces:: PLSQLParserConstants, PLSQLParserTreeConstants

public class PLSQLParser
extends Object
implements PLSQLParserTreeConstants, PLSQLParserConstants

Field Summary

Fields
Modifier and Type	Field and Description
`Token`	`jj_nt` Next token.
`protected JJTPLSQLParserState`	`jjtree`
`Token`	`token` Current token.
`PLSQLParserTokenManager`	`token_source` Generated Token Manager.

Fields inherited from interface net.sourceforge.pmd.lang.plsql.ast.PLSQLParserTreeConstants
JJTACCESSIBLEBYCLAUSE, JJTADDITIVEEXPRESSION, JJTALTERTRIGGER, JJTALTERTYPESPEC, JJTARGUMENT, JJTARGUMENTLIST, JJTARGUMENTS, JJTASSIGNMENT, JJTATTRIBUTE, JJTATTRIBUTEDECLARATION, JJTBLOCK, JJTBOOLEANLITERAL, JJTCALLSPECTAIL, JJTCASEEXPRESSION, JJTCASESTATEMENT, JJTCASEWHENCLAUSE, JJTCLOSESTATEMENT, JJTCOLLECTIONDECLARATION, JJTCOLLECTIONTYPEDEFINITION, JJTCOLLECTIONTYPENAME, JJTCOMMENT, JJTCOMPILATIONDATATYPE, JJTCOMPILATIONDECLARATIONFRAGMENT, JJTCOMPILATIONEXPRESSION, JJTCOMPOUNDTRIGGERBLOCK, JJTCONDITIONALANDEXPRESSION, JJTCONDITIONALCOMPILATIONSTATEMENT, JJTCONDITIONALOREXPRESSION, JJTCONTINUESTATEMENT, JJTCURSORBODY, JJTCURSORSPECIFICATION, JJTCURSORUNIT, JJTDATABASEEVENT, JJTDATABASELINK, JJTDATATYPE, JJTDATATYPEDECLARATION, JJTDATETIMELITERAL, JJTDDLCOMMAND, JJTDDLEVENT, JJTDECLARATIVESECTION, JJTDECLARATIVEUNIT, JJTDIRECTORY, JJTELSECLAUSE, JJTELSIFCLAUSE, JJTEMBEDDEDSQLSTATEMENT, JJTEQUALITYEXPRESSION, JJTEQUALSOLDIDNEWID, JJTEXCEPTIONDECLARATION, JJTEXCEPTIONHANDLER, JJTEXITSTATEMENT, JJTEXPRESSION, JJTFETCHSTATEMENT, JJTFIELDDECLARATION, JJTFORALLINDEX, JJTFORALLSTATEMENT, JJTFORINDEX, JJTFORMALPARAMETER, JJTFORMALPARAMETERS, JJTFORSTATEMENT, JJTGLOBAL, JJTGOTOSTATEMENT, JJTID, JJTIFSTATEMENT, JJTINLINEPRAGMA, JJTINPUT, JJTJAVAINTERFACECLASS, JJTKEYWORD_RESERVED, JJTKEYWORD_UNRESERVED, JJTLABEL, JJTLABELLEDSTATEMENT, JJTLIKEEXPRESSION, JJTLITERAL, JJTLOOPSTATEMENT, JJTMETHODDECLARATION, JJTMETHODDECLARATOR, JJTMULTIPLICATIVEEXPRESSION, JJTMULTISETCONDITION, JJTNAME, jjtNodeName, JJTNONDMLEVENT, JJTNONDMLTRIGGER, JJTNULLLITERAL, JJTNUMERICLITERAL, JJTOBJECTDECLARATION, JJTOBJECTEXPRESSION, JJTOBJECTNAMEDECLARATION, JJTOPENSTATEMENT, JJTPACKAGEBODY, JJTPACKAGESPECIFICATION, JJTPARALLELCLAUSE, JJTPIPELINESTATEMENT, JJTPRAGMA, JJTPRAGMACLAUSE, JJTPRIMARYEXPRESSION, JJTPRIMARYPREFIX, JJTPRIMARYSUFFIX, JJTPROGRAMUNIT, JJTQUALIFIEDID, JJTQUALIFIEDNAME, JJTRAISESTATEMENT, JJTREAD2NEXTOCCURRENCE, JJTREADPASTNEXTOCCURRENCE, JJTRELATIONALEXPRESSION, JJTRETURNSTATEMENT, JJTSCALARDATATYPENAME, JJTSKIP2NEXTOCCURRENCE, JJTSKIP2NEXTTERMINATOR, JJTSKIP2NEXTTOKENOCCURRENCE, JJTSKIPPASTNEXTOCCURRENCE, JJTSKIPPASTNEXTTOKENOCCURRENCE, JJTSQLPLUSCOMMAND, JJTSQLSTATEMENT, JJTSTATEMENT, JJTSTRINGEXPRESSION, JJTSTRINGLITERAL, JJTSUBTYPEDEFINITION, JJTSYNONYM, JJTTABLE, JJTTABLECOLUMN, JJTTRIGGERTIMINGPOINTSECTION, JJTTRIGGERUNIT, JJTTRIMEXPRESSION, JJTTYPEKEYWORD, JJTTYPEMETHOD, JJTTYPESPECIFICATION, JJTUNARYEXPRESSION, JJTUNARYEXPRESSIONNOTPLUSMINUS, JJTUNLABELLEDSTATEMENT, JJTUNQUALIFIEDID, JJTVARIABLEORCONSTANTDECLARATION, JJTVARIABLEORCONSTANTDECLARATOR, JJTVARIABLEORCONSTANTDECLARATORID, JJTVARIABLEORCONSTANTINITIALIZER, JJTVIEW, JJTVIEWCOLUMN, JJTWHILESTATEMENT, JJTWRAPPEDOBJECT

Fields inherited from interface net.sourceforge.pmd.lang.plsql.ast.PLSQLParserConstants
_CHARACTER, _CHARACTER_WO_ASTERISK, _DEFAULT, _WHATEVER_CHARACTER_WO_ASTERISK, _WHATEVER_CHARACTER_WO_QUOTE, A, ACCEPT, ACCESSIBLE, ADD, AFTER, AGGREGATE, ALL, ALTER, ANALYZE, AND, ANY, ARRAY, AS, ASC, ASSOCIATE, AT, ATTACH, ATTRIBUTE, AUDIT, AUTHENTICATED, AUTHID, AUTONOMOUS_TRANSACTION, AVG, BEFORE, BEGIN, BETWEEN, BFILE, BFILE_BASE, BINARY_INTEGER, BLOB, BLOB_BASE, BODY, BOOLEAN, BOTH, BULK, BY, BYTE, CALL, CASCADE, CASE, CAST, CC_ELSE, CC_ELSIF, CC_END, CC_ERROR, CC_IF, CC_PLSQL_LINE, CC_PLSQL_UNIT, CC_THEN, CHAR, CHAR_BASE, CHAR_CS, CHARACTER, CHARACTER_LITERAL, CHARSETFORM, CHARSETID, CHECK, CLOB, CLOB_BASE, CLOSE, CLUSTER, COALESCE, COLLECT, COLUMN, COMMENT, COMMIT, COMPOUND, COMPRESS, CONNECT, CONSTANT, CONSTRUCTOR, CONTEXT, CONTINUE, CONVERT, COPY, CREATE, CROSSEDITION, CURRENT, CURRENT_USER, CURRVAL, CURSOR, CUSTOMDATUM_CLASS, DATA, DATABASE, DATE, DATE_BASE, DAY, DBTIMEZONE, DDL, DEC, DECIMAL, DECLARE, DEFAULT, DEFINE, DEFINER, DELETE, DELIMITER, DESC, DETERMINISTIC, DIGIT, DIRECTORY, DISABLE, DISASSOCIATE, DISCONNECT, DISTINCT, DO, DOUBLE, DROP, EACH, EDITIONABLE, ELEMENT, ELSE, ELSIF, EMPTY, ENABLE, END, EOF, EOL, ESCAPE, EXCEPT, EXCEPTION, EXCEPTION_INIT, EXCEPTIONS, EXCLUSIVE, EXECUTE, EXISTS, EXIT, EXTENDS, EXTERNAL, EXTRACT, FALSE, FETCH, FINAL, FLOAT, FLOAT_LITERAL, FOLLOWS, FOR, FORALL, FORCE, FOREACHROW, FORMAL_COMMENT, FORWARD, FROM, FUNCTION, GERMAN_SPECIAL_CHARACTERS, GLOBAL, GOTO, GRANT, GROUP, HASH, HAVING, HEAP, HOST, HOUR, IDENTIFIED, IDENTIFIER, IF, IMMEDIATE, IN, IN_FORMAL_COMMENT, IN_MULTI_LINE_COMMENT, IN_SQL_STATEMENT_ENDED_SEMICOLON, INCLUDING, INDEX, INDEXTYPE, INDICATOR, INDICES, INLINE, INSERT, INSTANTIABLE, INSTEADOF, INT, INTEGER, INTEGER_LITERAL, INTERFACE, INTERSECT, INTERVAL, INTO, INVALIDATE, IS, ISOLATION, JAVA, JAVA_INTERFACE_CLASS, LANGUAGE, LEADING, LEFT, LENGTH, LETTER, LEVEL, LIBRARY, LIKE, LIMIT, LIMITED, LINK, LOCAL, LOCK, LOGOFF, LOGON, LONG, LOOP, MAP, MAX, MAXLEN, MEMBER, MERGE, MIN, MINUS, MINUTE, MLSLABEL, MOD, MODE, MODIFY, MONTH, MULTI_LINE_COMMENT, MULTISET, NAME, NATURAL, NATURALN, NCHAR, NCHAR_CS, NCLOB, NESTED, NEW, NEW_DOT, NEXTVAL, NLS_LENGTH_SEMANTICS, NO, NOAUDIT, NOCOMPRESS, NOCOPY, NONEDITIONABLE, NOT, NOWAIT, NULL, NULLIF, NUMBER, NUMBER_BASE, NUMERIC, NVARCHAR2, OBJECT, OCIROWID, OF, OID, OLD, ON, OPAQUE, OPEN, OPERATOR, OPTION, OR, ORADATA_CLASS, ORDER, ORGANIZATION, OTHERS, OUT, OVERRIDING, PACKAGE, PARALLEL_ENABLE, PARAMETERS, PARENT, PARTITION, PCTFREE, PIPE, PIPELINED, PLS_INTEGER, PLSQL_CCFLAGS, PLSQL_CODE_TYPE, PLSQL_DEBUG, PLSQL_OPTIMIZE_LEVEL, PLSQL_WARNINGS, POSITIVE, POSITIVEN, PRAGMA, PRECEDES, PRECISION, PRESERVE, PRINT, PRIOR, PRIVATE, PROCEDURE, PROMPT, PUBLIC, QUIT, QUOTED_LITERAL, RAISE, RANGE, RAW, REAL, RECORD, REF, REFERENCING, RELEASE, RELIES_ON, REMARK, RENAME, REPLACE, RESOURCE, RESTRICT_REFERENCES, RESULT, RESULT_CACHE, RETURN, RETURNING, REVERSE, REVOKE, RIGHT, ROLLBACK, ROW, ROWID, ROWNUM, ROWS, ROWTYPE, SAVE, SAVEPOINT, SCHEMA, SECOND, SELECT, SELF, SEPARATE, SERIALLY_REUSABLE, SERVERERROR, SESSIONTIMEZONE, SET, SHARE, SHARED, SHOW, SHUTDOWN, SIGNTYPE, SINGLE_LINE_COMMENT, SIZE, SMALLINT, SPACE, SPECIAL_CHARACTERS, SPOOL, SQL, SQLCODE, SQLDATA_CLASS, SQLERRM, SQLPLUS_TERMINATOR, START, STARTUP, STATEMENT, STATIC, STATISTICS, STDDEV, STRING, STRING_LITERAL, STRUCT, SUBMULTISET, SUBSTITUTABLE, SUBTYPE, SUCCESSFUL, SUM, SUSPEND, SYNONYM, SYS_REFCURSOR, SYSDATE, TABLE, TDO, TEMPORARY, THEN, TIME, TIMESTAMP, TIMEZONE_ABBR, TIMEZONE_HOUR, TIMEZONE_MINUTE, TIMEZONE_REGION, TO, tokenImage, TRAILING, TRANSACTION, TREAT, TRIGGER, TRIM, TRUE, TRUNCATE, TYPE, UI, UNDEFINE, UNDER, UNION, UNIQUE, UNSIGNED_NUMERIC_LITERAL, UPDATE, UROWID, USER, USING, VALUES, VARCHAR, VARCHAR2, VARIABLE, VARRAY, VARYING, VIEW, WHEN, WHENEVER, WHERE, WHILE, WITH, WRAPPED, YEAR, YES, ZONE

Constructor Summary

Constructors
Constructor and Description
`PLSQLParser(InputStream stream)` Constructor with InputStream.
`PLSQLParser(InputStream stream, String encoding)` Constructor with InputStream and supplied encoding
`PLSQLParser(PLSQLParserTokenManager tm)` Constructor with generated Token Manager.
`PLSQLParser(Reader stream)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`ASTAccessibleByClause`	`AccessibleByClause()`
`ASTAdditiveExpression`	`AdditiveExpression()`
`void`	`AlterTrigger()`
`ASTAlterTypeSpec`	`AlterTypeSpec()`
`ASTArgument`	`Argument()`
`ASTArgumentList`	`ArgumentList()`
`ASTArguments`	`Arguments()`
`ASTAssignment`	`Assignment()`
`ASTAttribute`	`Attribute()`
`ASTAttributeDeclaration`	`AttributeDeclaration()` Method
`ASTBlock`	`Block()`
`ASTBooleanLiteral`	`BooleanLiteral()`
`ASTCallSpecTail`	`CallSpecTail()` Java stored procedure, external function
`static String`	`canonicalName(String name)` Return canonical version of the Oracle
`ASTCaseExpression`	`CaseExpression()`
`ASTCaseStatement`	`CaseStatement()`
`ASTCaseWhenClause`	`CaseWhenClause()`
`ASTCloseStatement`	`CloseStatement()`
`ASTCollectionDeclaration`	`CollectionDeclaration()`
`ASTCollectionTypeDefinition`	`CollectionTypeDefinition()`
`ASTCollectionTypeName`	`CollectionTypeName()`
`ASTComment`	`Comment()`
`ASTCompilationDataType`	`CompilationDataType()`
`ASTCompilationDeclarationFragment`	`CompilationDeclarationFragment()`
`ASTCompilationExpression`	`CompilationExpression()`
`ASTCompoundTriggerBlock`	`CompoundTriggerBlock()`
`ASTConditionalAndExpression`	`ConditionalAndExpression()`
`ASTConditionalCompilationStatement`	`ConditionalCompilationStatement()`
`ASTConditionalOrExpression`	`ConditionalOrExpression()`
`ASTContinueStatement`	`ContinueStatement()`
`ASTCursorBody`	`CursorBody()`
`ASTCursorSpecification`	`CursorSpecification()`
`ASTCursorUnit`	`CursorUnit()` Cursor (common part of specification and body)
`ASTDatabaseEvent`	`DatabaseEvent()`
`ASTDatabaseLink`	`DatabaseLink()`
`ASTDatatype`	`Datatype()`
`ASTDatatypeDeclaration`	`DatatypeDeclaration()`
`ASTDateTimeLiteral`	`DateTimeLiteral()`
`ASTDDLCommand`	`DDLCommand()`
`ASTDDLEvent`	`DDLEvent()`
`ASTDeclarativeSection`	`DeclarativeSection()`
`ASTDeclarativeUnit`	`DeclarativeUnit()`
`ASTDirectory`	`Directory()`
`void`	`disable_tracing()` Disable tracing.
`ASTElseClause`	`ElseClause()`
`ASTElsifClause`	`ElsifClause()`
`ASTEmbeddedSqlStatement`	`EmbeddedSqlStatement()`
`void`	`enable_tracing()` Enable tracing.
`ASTEqualityExpression`	`EqualityExpression()`
`PLSQLNode`	`EqualsOldIDNewID(PLSQLNode pOldID)` Tests, if the new Token if type ID is identical to the old Token of type ID.
`ASTExceptionDeclaration`	`ExceptionDeclaration()`
`ASTExceptionHandler`	`ExceptionHandler()`
`ASTExitStatement`	`ExitStatement()`
`ASTExpression`	`Expression()`
`ASTFetchStatement`	`FetchStatement()`
`ASTFieldDeclaration`	`FieldDeclaration()`
`ASTForAllIndex`	`ForAllIndex()` ForAllIndex is declared implicitly, unlike most variables or constants.
`ASTForAllStatement`	`ForAllStatement()`
`ASTForIndex`	`ForIndex()` ForIndex is declared implicitly, unlike most variables or constants.
`ASTFormalParameter`	`FormalParameter()`
`ASTFormalParameters`	`FormalParameters()`
`ASTForStatement`	`ForStatement()` Scope rule: the loop index only exists within the Loop
`ParseException`	`generateParseException()` Generate ParseException.
`Token`	`getNextToken()` Get the next Token.
`Token`	`getToken(int index)` Get the specific Token.
`ASTGlobal`	`Global()` All global definitions of triggers, functions and procedures are evaluated here.
`ASTGotoStatement`	`GotoStatement()`
`ASTID`	`ID()` 2006-05-20 - Matthias Hendler - added and
`ASTIfStatement`	`IfStatement()`
`ASTInlinePragma`	`InlinePragma()`
`ASTInput`	`Input()` 2006-05-22 - Matthias Hendler - added globalBody()
`ASTJavaInterfaceClass`	`JavaInterfaceClass()`
`ASTKEYWORD_RESERVED`	`KEYWORD_RESERVED()`
`ASTKEYWORD_UNRESERVED`	`KEYWORD_UNRESERVED()`
`ASTLabel`	`Label()` This cannot be a token because these are valid labels '<< next_msg >>", '<<"OUTER LOOP">>'
`ASTLabelledStatement`	`LabelledStatement()`
`ASTLikeExpression`	`LikeExpression()`
`ASTLiteral`	`Literal()`
`ASTLoopStatement`	`LoopStatement()`
`static void`	`main(String[] args)` main method, for testing only.
`ASTMethodDeclaration`	`MethodDeclaration()`
`ASTMethodDeclarator`	`MethodDeclarator()`
`ASTMultiplicativeExpression`	`MultiplicativeExpression()`
`ASTMultiSetCondition`	`MultiSetCondition()`
`ASTName`	`Name()`
`ASTNonDMLEvent`	`NonDMLEvent()`
`ASTNonDMLTrigger`	`NonDMLTrigger()`
`ASTNullLiteral`	`NullLiteral()`
`ASTNumericLiteral`	`NumericLiteral()` Recognizes a numeric literal.
`ASTObjectDeclaration`	`ObjectDeclaration()`
`ASTObjectExpression`	`ObjectExpression()`
`ASTObjectNameDeclaration`	`ObjectNameDeclaration()`
`ASTOpenStatement`	`OpenStatement()`
`ASTPackageBody`	`PackageBody()`
`ASTPackageSpecification`	`PackageSpecification()`
`ASTParallelClause`	`ParallelClause()`
`ASTPipelineStatement`	`PipelineStatement()`
`ASTPragma`	`Pragma()`
`ASTPragmaClause`	`PragmaClause()`
`ASTPrimaryExpression`	`PrimaryExpression()` 2006-05-23 - Matthias Hendler - Added lookahead otherwise warning encountered.
`ASTPrimaryPrefix`	`PrimaryPrefix()`
`ASTPrimarySuffix`	`PrimarySuffix()`
`ASTProgramUnit`	`ProgramUnit()` 2006-05-22 - Matthias Hendler - Printing of custom tag "@deprecated" removed.
`ASTQualifiedID`	`QualifiedID()` 2006-05-20 - Matthias Hendler - added
`ASTQualifiedName`	`QualifiedName()`
`ASTRaiseStatement`	`RaiseStatement()`
`ASTRead2NextOccurrence`	`Read2NextOccurrence(String target)`
`ASTReadPastNextOccurrence`	`ReadPastNextOccurrence(String target)`
`void`	`ReInit(InputStream stream)` Reinitialise.
`void`	`ReInit(InputStream stream, String encoding)` Reinitialise.
`void`	`ReInit(PLSQLParserTokenManager tm)` Reinitialise.
`void`	`ReInit(Reader stream)` Reinitialise.
`ASTRelationalExpression`	`RelationalExpression()` 2006-05-23 - Matthias Hendler - added FROM
`ASTReturnStatement`	`ReturnStatement()`
`ASTScalarDataTypeName`	`ScalarDataTypeName()`
`void`	`Skip2NextOccurrence(String target)`
`void`	`Skip2NextTerminator(String initiator, String terminator)`
`void`	`Skip2NextTokenOccurrence(int target)`
`void`	`SkipPastNextOccurrence(String target)`
`void`	`SkipPastNextTokenOccurrence(int target)`
`ASTSqlPlusCommand`	`SqlPlusCommand()`
`ASTSqlStatement`	`SqlStatement(String initiator, String terminator)` 2006-05-24 - Matthias Hendler - added MERGE
`ASTStatement`	`Statement()`
`ASTStringExpression`	`StringExpression()`
`ASTStringLiteral`	`StringLiteral()`
`ASTSubTypeDefinition`	`SubTypeDefinition()`
`ASTSynonym`	`Synonym()`
`ASTTable`	`Table()` 2006-05-10 - Matthias Hendler - merged SIV and sourceforge sources
`ASTTableColumn`	`TableColumn()`
`ASTTriggerTimingPointSection`	`TriggerTimingPointSection()`
`ASTTriggerUnit`	`TriggerUnit()` Trigger Triggers are always outside of a package.
`ASTTrimExpression`	`TrimExpression()`
`ASTTypeKeyword`	`TypeKeyword()`
`ASTTypeMethod`	`TypeMethod()`
`ASTTypeSpecification`	`TypeSpecification()`
`ASTUnaryExpression`	`UnaryExpression(boolean isUnarySign)`
`ASTUnaryExpressionNotPlusMinus`	`UnaryExpressionNotPlusMinus()`
`ASTUnlabelledStatement`	`UnlabelledStatement()` 2006-05-24 - Matthias Hendler - added MERGE, EXECUTE choice and LOOKAHEAD at
`ASTUnqualifiedID`	`UnqualifiedID()` 2006-05-20 - Matthias Hendler - added , , ,
`ASTVariableOrConstantDeclaration`	`VariableOrConstantDeclaration()`
`ASTVariableOrConstantDeclarator`	`VariableOrConstantDeclarator()`
`ASTVariableOrConstantDeclaratorId`	`VariableOrConstantDeclaratorId()`
`ASTVariableOrConstantInitializer`	`VariableOrConstantInitializer()`
`ASTView`	`View()`
`ASTViewColumn`	`ViewColumn()`
`ASTWhileStatement`	`WhileStatement()`
`void`	`WrappedObject()` 2011-05-15 - SRT - Added to cope with wrapped objects A wrapped function looks like this (always terminated by one or more equals signs "="):- " CREATE OR REPLACE FUNCTION "TESTUSER"."GET_DATE_STRING" / ** Return SYSDATE formatted using the provided template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jjtree
```
protected JJTPLSQLParserState jjtree
```

token_source

public PLSQLParserTokenManager token_source

Generated Token Manager.

token
```
public Token token
```
Current token.

jj_nt
```
public Token jj_nt
```
Next token.

Constructor Detail

PLSQLParser

public PLSQLParser(InputStream stream)

Constructor with InputStream.

PLSQLParser

public PLSQLParser(InputStream stream,
           String encoding)

Constructor with InputStream and supplied encoding

PLSQLParser
```
public PLSQLParser(Reader stream)
```
Constructor.

PLSQLParser
```
public PLSQLParser(PLSQLParserTokenManager tm)
```
Constructor with generated Token Manager.

Method Detail

main

public static void main(String[] args)
                 throws ParseException

main method, for testing only.

Parameters:: args -
Throws:: ParseException

canonicalName

public static String canonicalName(String name)

Return canonical version of the Oracle

Input

public final ASTInput Input()
                     throws ParseException

2006-05-22 - Matthias Hendler - added globalBody()

Throws:: ParseException

DDLCommand

public final ASTDDLCommand DDLCommand()
                               throws ParseException

Throws:: ParseException

SqlPlusCommand

public final ASTSqlPlusCommand SqlPlusCommand()
                                       throws ParseException

Throws:: ParseException

Global
```
public final ASTGlobal Global()
                       throws ParseException
```
All global definitions of triggers, functions and procedures are evaluated here. Every occurence goes under a new PACKAGE-Node in the XML document. This happens, cause a global "block" does not have a definied start and end token like a package specification or a package body. Thats why every construct is handled like a new part of the global package. To overcome this problem, I could use an infinity lookahead - which should solve the problem and slow down the whole parsing. Another idea would be to lookahead the next tokens and decide wether they belong to a package definition or not. Then I could decide to stay in this global parsing state. By now lookahead gives the parser a hint to choose the correct way on a given base. So we can't negate it easily. On the other hand I could also hold the global state in a global variable. But this does not seems the correct way to solve the problem, I think. 2006-05-17 - Matthias Hendler - added

Throws:

ParseException

Block

public final ASTBlock Block()
                     throws ParseException

Throws:: ParseException

PackageSpecification

public final ASTPackageSpecification PackageSpecification()
                                                   throws ParseException

Throws:: ParseException

PackageBody

public final ASTPackageBody PackageBody()
                                 throws ParseException

Throws:: ParseException

DeclarativeUnit

public final ASTDeclarativeUnit DeclarativeUnit()
                                         throws ParseException

Throws:: ParseException

DeclarativeSection

public final ASTDeclarativeSection DeclarativeSection()
                                               throws ParseException

Throws:: ParseException

CompilationDeclarationFragment

public final ASTCompilationDeclarationFragment CompilationDeclarationFragment()
                                                                       throws ParseException

Throws:: ParseException

ProgramUnit
```
public final ASTProgramUnit ProgramUnit()
                                 throws ParseException
```
2006-05-22 - Matthias Hendler - Printing of custom tag "@deprecated" removed. Printing of any custom tag added. Now user can define his own custom tags which he can evaluate in the XSLT. This methode also documents global functions/procedures.

Throws:

ParseException

ObjectNameDeclaration

public final ASTObjectNameDeclaration ObjectNameDeclaration()
                                                     throws ParseException

Throws:: ParseException

FormalParameter

public final ASTFormalParameter FormalParameter()
                                         throws ParseException

Throws:: ParseException

MethodDeclaration

public final ASTMethodDeclaration MethodDeclaration()
                                             throws ParseException

Throws:: ParseException

MethodDeclarator

public final ASTMethodDeclarator MethodDeclarator()
                                           throws ParseException

Throws:: ParseException

FormalParameters

public final ASTFormalParameters FormalParameters()
                                           throws ParseException

Throws:: ParseException

VariableOrConstantDeclarator

public final ASTVariableOrConstantDeclarator VariableOrConstantDeclarator()
                                                                   throws ParseException

Throws:: ParseException

VariableOrConstantDeclaratorId

public final ASTVariableOrConstantDeclaratorId VariableOrConstantDeclaratorId()
                                                                       throws ParseException

Throws:: ParseException

VariableOrConstantInitializer

public final ASTVariableOrConstantInitializer VariableOrConstantInitializer()
                                                                     throws ParseException

Throws:: ParseException

Datatype

public final ASTDatatype Datatype()
                           throws ParseException

Throws:: ParseException

CompilationDataType

public final ASTCompilationDataType CompilationDataType()
                                                 throws ParseException

Throws:: ParseException

CollectionTypeName

public final ASTCollectionTypeName CollectionTypeName()
                                               throws ParseException

Throws:: ParseException

ScalarDataTypeName

public final ASTScalarDataTypeName ScalarDataTypeName()
                                               throws ParseException

Throws:: ParseException

DateTimeLiteral

public final ASTDateTimeLiteral DateTimeLiteral()
                                         throws ParseException

Throws:: ParseException

ExceptionHandler

public final ASTExceptionHandler ExceptionHandler()
                                           throws ParseException

Throws:: ParseException

Skip2NextTerminator

public final void Skip2NextTerminator(String initiator,
                       String terminator)
                               throws ParseException

Throws:: ParseException

Skip2NextOccurrence

public final void Skip2NextOccurrence(String target)
                               throws ParseException

Throws:: ParseException

SkipPastNextOccurrence

public final void SkipPastNextOccurrence(String target)
                                  throws ParseException

Throws:: ParseException

Skip2NextTokenOccurrence

public final void Skip2NextTokenOccurrence(int target)
                                    throws ParseException

Throws:: ParseException

SkipPastNextTokenOccurrence

public final void SkipPastNextTokenOccurrence(int target)
                                       throws ParseException

Throws:: ParseException

Read2NextOccurrence

public final ASTRead2NextOccurrence Read2NextOccurrence(String target)
                                                 throws ParseException

Throws:: ParseException

ReadPastNextOccurrence

public final ASTReadPastNextOccurrence ReadPastNextOccurrence(String target)
                                                       throws ParseException

Throws:: ParseException

SqlStatement

public final ASTSqlStatement SqlStatement(String initiator,
                           String terminator)
                                   throws ParseException

2006-05-24 - Matthias Hendler - added MERGE

Throws:: ParseException

WrappedObject
```
public final void WrappedObject()
                         throws ParseException
```
2011-05-15 - SRT - Added to cope with wrapped objects A wrapped function looks like this (always terminated by one or more equals signs "="):- " CREATE OR REPLACE FUNCTION "TESTUSER"."GET_DATE_STRING" / ** Return SYSDATE formatted using the provided template.

Parameters:
p_date_format - normal TO_CHARE/TO_DATE date template

Throws:

ParseException
See Also:
/ wrapped a000000 369 abcd abcd abcd abcd abcd abcd abcd abcd abcd abcd abcd abcd abcd abcd abcd 8 89 b6 /SBrhM8+1iUO4QAih+qD2SK8kSowg8eZgcfLCNL+XlquYvSuoVah8JbRPpdHDLHn479SdFLw v04omzJ0zOfHdMAzuHQlw+fAsr2ym9YI8I521pRTbnFVAHOOUw4JqPkIyj7wj4VwyL17nhYb 3qPVuL6SvhZTmEBnRtaErHpzaDuIpqZ0G4s= "

UnlabelledStatement

public final ASTUnlabelledStatement UnlabelledStatement()
                                                 throws ParseException

2006-05-24 - Matthias Hendler - added MERGE, EXECUTE choice and LOOKAHEAD at

Throws:: ParseException

Statement

public final ASTStatement Statement()
                             throws ParseException

Throws:: ParseException

LabelledStatement

public final ASTLabelledStatement LabelledStatement()
                                             throws ParseException

Throws:: ParseException

CaseStatement

public final ASTCaseStatement CaseStatement()
                                     throws ParseException

Throws:: ParseException

CaseWhenClause

public final ASTCaseWhenClause CaseWhenClause()
                                       throws ParseException

Throws:: ParseException

ElseClause

public final ASTElseClause ElseClause()
                               throws ParseException

Throws:: ParseException

ElsifClause

public final ASTElsifClause ElsifClause()
                                 throws ParseException

Throws:: ParseException

LoopStatement

public final ASTLoopStatement LoopStatement()
                                     throws ParseException

Throws:: ParseException

ForStatement

public final ASTForStatement ForStatement()
                                   throws ParseException

Scope rule: the loop index only exists within the Loop

Throws:: ParseException

WhileStatement

public final ASTWhileStatement WhileStatement()
                                       throws ParseException

Throws:: ParseException

IfStatement

public final ASTIfStatement IfStatement()
                                 throws ParseException

Throws:: ParseException

ForIndex
```
public final ASTForIndex ForIndex()
                           throws ParseException
```
ForIndex is declared implicitly, unlike most variables or constants.

Throws:

ParseException

ForAllIndex

public final ASTForAllIndex ForAllIndex()
                                 throws ParseException

ForAllIndex is declared implicitly, unlike most variables or constants.

Throws:: ParseException

ForAllStatement

public final ASTForAllStatement ForAllStatement()
                                         throws ParseException

Throws:: ParseException

GotoStatement

public final ASTGotoStatement GotoStatement()
                                     throws ParseException

Throws:: ParseException

ReturnStatement

public final ASTReturnStatement ReturnStatement()
                                         throws ParseException

Throws:: ParseException

ContinueStatement

public final ASTContinueStatement ContinueStatement()
                                             throws ParseException

Throws:: ParseException

ExitStatement

public final ASTExitStatement ExitStatement()
                                     throws ParseException

Throws:: ParseException

RaiseStatement

public final ASTRaiseStatement RaiseStatement()
                                       throws ParseException

Throws:: ParseException

CloseStatement

public final ASTCloseStatement CloseStatement()
                                       throws ParseException

Throws:: ParseException

OpenStatement

public final ASTOpenStatement OpenStatement()
                                     throws ParseException

Throws:: ParseException

FetchStatement

public final ASTFetchStatement FetchStatement()
                                       throws ParseException

Throws:: ParseException

EmbeddedSqlStatement

public final ASTEmbeddedSqlStatement EmbeddedSqlStatement()
                                                   throws ParseException

Throws:: ParseException

PipelineStatement

public final ASTPipelineStatement PipelineStatement()
                                             throws ParseException

Throws:: ParseException

ConditionalCompilationStatement

public final ASTConditionalCompilationStatement ConditionalCompilationStatement()
                                                                         throws ParseException

Throws:: ParseException

SubTypeDefinition

public final ASTSubTypeDefinition SubTypeDefinition()
                                             throws ParseException

Throws:: ParseException

FieldDeclaration

public final ASTFieldDeclaration FieldDeclaration()
                                           throws ParseException

Throws:: ParseException

CollectionTypeDefinition

public final ASTCollectionTypeDefinition CollectionTypeDefinition()
                                                           throws ParseException

Throws:: ParseException

CollectionDeclaration

public final ASTCollectionDeclaration CollectionDeclaration()
                                                     throws ParseException

Throws:: ParseException

ObjectDeclaration

public final ASTObjectDeclaration ObjectDeclaration()
                                             throws ParseException

Throws:: ParseException

CallSpecTail

public final ASTCallSpecTail CallSpecTail()
                                   throws ParseException

Java stored procedure, external function

Throws:: ParseException

CursorUnit

public final ASTCursorUnit CursorUnit()
                               throws ParseException

Cursor (common part of specification and body)

Throws:: ParseException

CursorSpecification

public final ASTCursorSpecification CursorSpecification()
                                                 throws ParseException

Throws:: ParseException

CursorBody

public final ASTCursorBody CursorBody()
                               throws ParseException

Throws:: ParseException

Expression

public final ASTExpression Expression()
                               throws ParseException

Throws:: ParseException

CompilationExpression

public final ASTCompilationExpression CompilationExpression()
                                                     throws ParseException

Throws:: ParseException

Assignment

public final ASTAssignment Assignment()
                               throws ParseException

Throws:: ParseException

CaseExpression

public final ASTCaseExpression CaseExpression()
                                       throws ParseException

Throws:: ParseException

LikeExpression

public final ASTLikeExpression LikeExpression()
                                       throws ParseException

Throws:: ParseException

TrimExpression

public final ASTTrimExpression TrimExpression()
                                       throws ParseException

Throws:: ParseException

ObjectExpression

public final ASTObjectExpression ObjectExpression()
                                           throws ParseException

Throws:: ParseException

ConditionalOrExpression

public final ASTConditionalOrExpression ConditionalOrExpression()
                                                         throws ParseException

Throws:: ParseException

ConditionalAndExpression

public final ASTConditionalAndExpression ConditionalAndExpression()
                                                           throws ParseException

Throws:: ParseException

EqualityExpression

public final ASTEqualityExpression EqualityExpression()
                                               throws ParseException

Throws:: ParseException

RelationalExpression

public final ASTRelationalExpression RelationalExpression()
                                                   throws ParseException

2006-05-23 - Matthias Hendler - added FROM

Throws:: ParseException

AdditiveExpression

public final ASTAdditiveExpression AdditiveExpression()
                                               throws ParseException

Throws:: ParseException

StringExpression

public final ASTStringExpression StringExpression()
                                           throws ParseException

Throws:: ParseException

MultiplicativeExpression

public final ASTMultiplicativeExpression MultiplicativeExpression()
                                                           throws ParseException

Throws:: ParseException

UnaryExpression

public final ASTUnaryExpression UnaryExpression(boolean isUnarySign)
                                         throws ParseException

Throws:: ParseException

UnaryExpressionNotPlusMinus

public final ASTUnaryExpressionNotPlusMinus UnaryExpressionNotPlusMinus()
                                                                 throws ParseException

Throws:: ParseException

PrimaryExpression
```
public final ASTPrimaryExpression PrimaryExpression()
                                             throws ParseException
```
2006-05-23 - Matthias Hendler - Added lookahead otherwise warning encountered. Warning arised while adding methode triggerUnit(). 2011-04-27 - SRT - Add optional NEW Keyword to cope with Object Type constructors

Throws:

ParseException

PrimaryPrefix

public final ASTPrimaryPrefix PrimaryPrefix()
                                     throws ParseException

Throws:: ParseException

PrimarySuffix

public final ASTPrimarySuffix PrimarySuffix()
                                     throws ParseException

Throws:: ParseException

Literal

public final ASTLiteral Literal()
                         throws ParseException

Throws:: ParseException

StringLiteral

public final ASTStringLiteral StringLiteral()
                                     throws ParseException

Throws:: ParseException

BooleanLiteral

public final ASTBooleanLiteral BooleanLiteral()
                                       throws ParseException

Throws:: ParseException

NullLiteral

public final ASTNullLiteral NullLiteral()
                                 throws ParseException

Throws:: ParseException

MultiSetCondition

public final ASTMultiSetCondition MultiSetCondition()
                                             throws ParseException

Throws:: ParseException

NumericLiteral
```
public final ASTNumericLiteral NumericLiteral()
                                       throws ParseException
```
Recognizes a numeric literal. This may look like token, but it isn't. Not atomic enough. E.g. "+1" would be valid literal, which make parsing of "i+1" impossible (here, we have tokens "i", "+" and "1")

Throws:

ParseException

Label
```
public final ASTLabel Label()
                     throws ParseException
```
This cannot be a token because these are valid labels '<< next_msg >>", '<<"OUTER LOOP">>'

Throws:

ParseException

Name

public final ASTName Name()
                   throws ParseException

Throws:: ParseException

QualifiedName

public final ASTQualifiedName QualifiedName()
                                     throws ParseException

Throws:: ParseException

Arguments

public final ASTArguments Arguments()
                             throws ParseException

Throws:: ParseException

ArgumentList

public final ASTArgumentList ArgumentList()
                                   throws ParseException

Throws:: ParseException

Argument

public final ASTArgument Argument()
                           throws ParseException

Throws:: ParseException

VariableOrConstantDeclaration

public final ASTVariableOrConstantDeclaration VariableOrConstantDeclaration()
                                                                     throws ParseException

Throws:: ParseException

DatatypeDeclaration

public final ASTDatatypeDeclaration DatatypeDeclaration()
                                                 throws ParseException

Throws:: ParseException

Pragma

public final ASTPragma Pragma()
                       throws ParseException

Throws:: ParseException

InlinePragma

public final ASTInlinePragma InlinePragma()
                                   throws ParseException

Throws:: ParseException

ExceptionDeclaration

public final ASTExceptionDeclaration ExceptionDeclaration()
                                                   throws ParseException

Throws:: ParseException

ParallelClause

public final ASTParallelClause ParallelClause()
                                       throws ParseException

Throws:: ParseException

AccessibleByClause

public final ASTAccessibleByClause AccessibleByClause()
                                               throws ParseException

Throws:: ParseException

Table
```
public final ASTTable Table()
                     throws ParseException
```
2006-05-10 - Matthias Hendler - merged SIV and sourceforge sources

Throws:

ParseException

TableColumn

public final ASTTableColumn TableColumn()
                                 throws ParseException

Throws:: ParseException

View

public final ASTView View()
                   throws ParseException

Throws:: ParseException

Synonym

public final ASTSynonym Synonym()
                         throws ParseException

Throws:: ParseException

DatabaseLink

public final ASTDatabaseLink DatabaseLink()
                                   throws ParseException

Throws:: ParseException

ViewColumn

public final ASTViewColumn ViewColumn()
                               throws ParseException

Throws:: ParseException

Comment

public final ASTComment Comment()
                         throws ParseException

Throws:: ParseException

TypeMethod

public final ASTTypeMethod TypeMethod()
                               throws ParseException

Throws:: ParseException

TypeSpecification

public final ASTTypeSpecification TypeSpecification()
                                             throws ParseException

Throws:: ParseException

AlterTypeSpec

public final ASTAlterTypeSpec AlterTypeSpec()
                                     throws ParseException

Throws:: ParseException

AttributeDeclaration

public final ASTAttributeDeclaration AttributeDeclaration()
                                                   throws ParseException

Method

Throws:: ParseException

Attribute

public final ASTAttribute Attribute()
                             throws ParseException

Throws:: ParseException

PragmaClause

public final ASTPragmaClause PragmaClause()
                                   throws ParseException

Throws:: ParseException

TriggerUnit
```
public final ASTTriggerUnit TriggerUnit()
                                 throws ParseException
```
Trigger Triggers are always outside of a package. 2006-05-17 - Matthias Hendler - added

Throws:

ParseException

TriggerTimingPointSection

public final ASTTriggerTimingPointSection TriggerTimingPointSection()
                                                             throws ParseException

Throws:: ParseException

CompoundTriggerBlock

public final ASTCompoundTriggerBlock CompoundTriggerBlock()
                                                   throws ParseException

Throws:: ParseException

NonDMLTrigger

public final ASTNonDMLTrigger NonDMLTrigger()
                                     throws ParseException

Throws:: ParseException

DDLEvent

public final ASTDDLEvent DDLEvent()
                           throws ParseException

Throws:: ParseException

DatabaseEvent

public final ASTDatabaseEvent DatabaseEvent()
                                     throws ParseException

Throws:: ParseException

NonDMLEvent

public final ASTNonDMLEvent NonDMLEvent()
                                 throws ParseException

Throws:: ParseException

AlterTrigger

public final void AlterTrigger()
                        throws ParseException

Throws:: ParseException

KEYWORD_RESERVED

public final ASTKEYWORD_RESERVED KEYWORD_RESERVED()
                                           throws ParseException

Throws:: ParseException

KEYWORD_UNRESERVED

public final ASTKEYWORD_UNRESERVED KEYWORD_UNRESERVED()
                                               throws ParseException

Throws:: ParseException

ID

public final ASTID ID()
               throws ParseException

2006-05-20 - Matthias Hendler - added and

Throws:: ParseException

UnqualifiedID

public final ASTUnqualifiedID UnqualifiedID()
                                     throws ParseException

2006-05-20 - Matthias Hendler - added , , ,

Throws:: ParseException

QualifiedID

public final ASTQualifiedID QualifiedID()
                                 throws ParseException

2006-05-20 - Matthias Hendler - added

Throws:: ParseException

TypeKeyword

public final ASTTypeKeyword TypeKeyword()
                                 throws ParseException

Throws:: ParseException

JavaInterfaceClass

public final ASTJavaInterfaceClass JavaInterfaceClass()
                                               throws ParseException

Throws:: ParseException

EqualsOldIDNewID
```
public final PLSQLNode EqualsOldIDNewID(PLSQLNode pOldID)
                                 throws ParseException
```
Tests, if the new Token if type ID is identical to the old Token of type ID. 2006-05-18 - Matthias Hendler - added: Just for understanding javacc and not used, cause to many closing ENDs (IDENTIFIER) were mistyped.

Throws:

ParseException

ReInit

public void ReInit(InputStream stream)

Reinitialise.

ReInit

public void ReInit(InputStream stream,
          String encoding)

Reinitialise.

ReInit
```
public void ReInit(Reader stream)
```
Reinitialise.

ReInit

public void ReInit(PLSQLParserTokenManager tm)

Reinitialise.

getNextToken
```
public final Token getNextToken()
```
Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing
```
public final void enable_tracing()
```
Enable tracing.

disable_tracing
```
public final void disable_tracing()
```
Disable tracing.

Class PLSQLParser

Field Summary

Fields inherited from interface net.sourceforge.pmd.lang.plsql.ast.PLSQLParserTreeConstants

Fields inherited from interface net.sourceforge.pmd.lang.plsql.ast.PLSQLParserConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jjtree

token_source

token

jj_nt

Constructor Detail

PLSQLParser

PLSQLParser

PLSQLParser

PLSQLParser

Method Detail

main

canonicalName

Input

DDLCommand

SqlPlusCommand

Global

Block

PackageSpecification

PackageBody

DeclarativeUnit

DeclarativeSection

CompilationDeclarationFragment

ProgramUnit

ObjectNameDeclaration

FormalParameter

MethodDeclaration

MethodDeclarator

FormalParameters

VariableOrConstantDeclarator

VariableOrConstantDeclaratorId

VariableOrConstantInitializer

Datatype

CompilationDataType

CollectionTypeName

ScalarDataTypeName

DateTimeLiteral

ExceptionHandler

Skip2NextTerminator

Skip2NextOccurrence

SkipPastNextOccurrence

Skip2NextTokenOccurrence

SkipPastNextTokenOccurrence

Read2NextOccurrence

ReadPastNextOccurrence

SqlStatement

WrappedObject

UnlabelledStatement

Statement

LabelledStatement

CaseStatement

CaseWhenClause

ElseClause

ElsifClause

LoopStatement

ForStatement

WhileStatement

IfStatement

ForIndex

ForAllIndex

ForAllStatement

GotoStatement

ReturnStatement

ContinueStatement

ExitStatement

RaiseStatement

CloseStatement

OpenStatement

FetchStatement

EmbeddedSqlStatement

PipelineStatement

ConditionalCompilationStatement

SubTypeDefinition