DRL5Parser (Drools :: Compiler 6.5.0.Final API)

java.lang.Object
- org.drools.compiler.lang.AbstractDRLParser
- - org.drools.compiler.lang.DRL5Parser

All Implemented Interfaces:: DRLParser

public class DRL5Parser
extends AbstractDRLParser
implements DRLParser

Field Summary
- Fields inherited from class org.drools.compiler.lang.AbstractDRLParser
  helper, input, state

Constructor Summary

Constructors
Constructor and Description

DRL5Parser(org.antlr.runtime.TokenStream input)

Constructors
Constructor and Description
`DRL5Parser(org.antlr.runtime.TokenStream input)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttributeDescr`	`attribute(AttributeSupportBuilder<?> as)` attribute := salience \| enabled \| ( NO-LOOP \| AUTO-FOCUS \| LOCK-ON-ACTIVE \| REFRACT ) BOOLEAN?
`String`	`chunk(int leftDelimiter, int rightDelimiter, int location)` Matches a chunk started by the leftDelimiter and ended by the rightDelimiter.
`protected PackageDescr`	`compilationUnit(PackageDescrBuilder pkg)`
`String`	`conditionalExpression()` Matches a conditional expression
`String`	`conditionalOrExpression()` Matches a conditional \|\| expression
`BaseDescr`	`declare(PackageDescrBuilder pkg)` declare := DECLARE \| (ENTRY-POINT) => entryPointDeclaration \| (WINDOW) => windowDeclaration \| (TRAIT) => typeDeclaration (trait) \| (ENUM) => enumDeclaration \| typeDeclaration (class) END
`void`	`defaultConsequence(RuleDescrBuilder rule)` defaultConsequence := THEN chunk
`EntryPointDeclarationDescr`	`entryPointDeclaration(DeclareDescrBuilder ddb)` entryPointDeclaration := ENTRY-POINT stringId annotation* END
`EnumDeclarationDescr`	`enumDeclaration(DeclareDescrBuilder ddb)`
`FunctionDescr`	`function(PackageDescrBuilder pkg)` function := FUNCTION type?
`protected org.kie.internal.builder.conf.LanguageLevelOption`	`getLanguageLevel()`
`GlobalDescr`	`globalStatement(PackageDescrBuilder pkg)` globalStatement := GLOBAL type ID
`ImportDescr`	`importStatement(PackageDescrBuilder pkg)` importStatement := IMPORT (FUNCTION\|STATIC)?
`boolean`	`mismatchIsMissingToken(org.antlr.runtime.TokenStream input, int[] follow)`
`boolean`	`mismatchIsUnwantedToken(org.antlr.runtime.TokenStream input, int ttype, String text)`
`void`	`namedConsequence(RuleDescrBuilder rule)` namedConsequence := THEN LEFT_SQUARE ID RIGHT_SQUARE chunk
`String`	`packageStatement(PackageDescrBuilder pkg)` Parses a package statement and returns the name of the package or null if none is defined.
`String`	`qualifiedIdentifier()` Matches a qualified identifier qualifiedIdentifier := ID ( DOT ID )*
`RuleDescr`	`query(PackageDescrBuilder pkg)` query := QUERY stringId parameters?
`protected org.antlr.runtime.Token`	`recoverFromMismatchedToken(org.antlr.runtime.TokenStream input, int ttype, String text, int[] follow)` Attempt to recover from a single missing or extra token.
`RuleDescr`	`rule(PackageDescrBuilder pkg)` rule := RULE stringId (EXTENDS stringId)?
`BaseDescr`	`statement(PackageDescrBuilder pkg)` statement := importStatement \| globalStatement \| declare \| rule \| ruleAttribute \| function \| query ;
`String`	`type()` Matches a type name type := ID typeArguments?
`String`	`typeArgument()` Matches a type argument typeArguments := QUESTION (( EXTENDS \| SUPER ) type )?
`String`	`typeArguments()` Matches type arguments typeArguments := LESS typeArgument (COMMA typeArgument)* GREATER
`TypeDeclarationDescr`	`typeDeclaration(DeclareDescrBuilder ddb, boolean isTrait)` typeDeclaration := [TYPE] qualifiedIdentifier (EXTENDS qualifiedIdentifier)?
`WindowDeclarationDescr`	`windowDeclaration(DeclareDescrBuilder ddb)` windowDeclaration := WINDOW ID annotation* lhsPatternBind END

Methods inherited from class org.drools.compiler.lang.AbstractDRLParser
compilationUnit, compilationUnit, disableEditorInterface, enableEditorInterface, getEditorInterface, getErrorMessages, getErrors, getHelper, hasErrors, reportError, reportError

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

Methods inherited from interface org.drools.compiler.lang.DRLParser
compilationUnit, compilationUnit, disableEditorInterface, enableEditorInterface, getEditorInterface, getErrorMessages, getErrors, hasErrors, reportError, reportError

- Constructor Detail
  - DRL5Parser
```
public DRL5Parser(org.antlr.runtime.TokenStream input)
```
- Method Detail
  - getLanguageLevel
```
protected org.kie.internal.builder.conf.LanguageLevelOption getLanguageLevel()
```
    Specified by:
    
    getLanguageLevel in class AbstractDRLParser
  - compilationUnit
```
protected final PackageDescr compilationUnit(PackageDescrBuilder pkg)
                                      throws org.antlr.runtime.RecognitionException
```
    Specified by:
    
    compilationUnit in class AbstractDRLParser
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - packageStatement
```
public String packageStatement(PackageDescrBuilder pkg)
                        throws org.antlr.runtime.RecognitionException
```
    Parses a package statement and returns the name of the package or null if none is defined. packageStatement := PACKAGE qualifiedIdentifier SEMICOLON?
    
    Returns:
    
    the name of the package or null if none is defined
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - statement
```
public BaseDescr statement(PackageDescrBuilder pkg)
                    throws org.antlr.runtime.RecognitionException
```
    statement := importStatement | globalStatement | declare | rule | ruleAttribute | function | query ;
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - importStatement
```
public ImportDescr importStatement(PackageDescrBuilder pkg)
                            throws org.antlr.runtime.RecognitionException
```
    importStatement := IMPORT (FUNCTION|STATIC)? qualifiedIdentifier (DOT STAR)?
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - globalStatement
```
public GlobalDescr globalStatement(PackageDescrBuilder pkg)
                            throws org.antlr.runtime.RecognitionException
```
    globalStatement := GLOBAL type ID
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - declare
```
public BaseDescr declare(PackageDescrBuilder pkg)
                  throws org.antlr.runtime.RecognitionException
```
    declare := DECLARE | (ENTRY-POINT) => entryPointDeclaration | (WINDOW) => windowDeclaration | (TRAIT) => typeDeclaration (trait) | (ENUM) => enumDeclaration | typeDeclaration (class) END
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - entryPointDeclaration
```
public EntryPointDeclarationDescr entryPointDeclaration(DeclareDescrBuilder ddb)
                                                 throws org.antlr.runtime.RecognitionException
```
    entryPointDeclaration := ENTRY-POINT stringId annotation* END
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - windowDeclaration
```
public WindowDeclarationDescr windowDeclaration(DeclareDescrBuilder ddb)
                                         throws org.antlr.runtime.RecognitionException
```
    windowDeclaration := WINDOW ID annotation* lhsPatternBind END
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - enumDeclaration
```
public EnumDeclarationDescr enumDeclaration(DeclareDescrBuilder ddb)
                                     throws org.antlr.runtime.RecognitionException
```
    Throws:
    
    org.antlr.runtime.RecognitionException
  - typeDeclaration
```
public TypeDeclarationDescr typeDeclaration(DeclareDescrBuilder ddb,
                                            boolean isTrait)
                                     throws org.antlr.runtime.RecognitionException
```
    typeDeclaration := [TYPE] qualifiedIdentifier (EXTENDS qualifiedIdentifier)? annotation* field* END
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - function
```
public FunctionDescr function(PackageDescrBuilder pkg)
                       throws org.antlr.runtime.RecognitionException
```
    function := FUNCTION type? ID parameters(typed) chunk_{_}
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - query
```
public RuleDescr query(PackageDescrBuilder pkg)
                throws org.antlr.runtime.RecognitionException
```
    query := QUERY stringId parameters? annotation* lhsExpression END
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - rule
```
public RuleDescr rule(PackageDescrBuilder pkg)
               throws org.antlr.runtime.RecognitionException
```
    rule := RULE stringId (EXTENDS stringId)? annotation* attributes? lhs? rhs END
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - attribute
```
public AttributeDescr attribute(AttributeSupportBuilder<?> as)
```
    attribute := salience | enabled | ( NO-LOOP | AUTO-FOCUS | LOCK-ON-ACTIVE | REFRACT ) BOOLEAN? | ( AGENDA-GROUP | ACTIVATION-GROUP | RULEFLOW-GROUP | DATE-EFFECTIVE | DATE-EXPIRES | DIALECT ) STRING | CALENDARS STRING (COMMA STRING)* | TIMER ( DECIMAL | chunk_(_) ) | DURATION ( DECIMAL | chunk_(_) ) The above syntax is not quite how this is parsed, because the soft keyword is determined by look-ahead and passed on to one of the x-Attribute methods (booleanAttribute, stringAttribute, stringListAttribute, intOrChunkAttribute) which will actually gobble the tokens.
    
    Returns:
  - defaultConsequence
```
public void defaultConsequence(RuleDescrBuilder rule)
```
    defaultConsequence := THEN chunk
    
    Parameters:
    
    rule -
  - namedConsequence
```
public void namedConsequence(RuleDescrBuilder rule)
```
    namedConsequence := THEN LEFT_SQUARE ID RIGHT_SQUARE chunk
    
    Parameters:
    
    rule -
  - type
```
public String type()
            throws org.antlr.runtime.RecognitionException
```
    Matches a type name type := ID typeArguments? ( DOT ID typeArguments? )* (LEFT_SQUARE RIGHT_SQUARE)*
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - typeArguments
```
public String typeArguments()
                     throws org.antlr.runtime.RecognitionException
```
    Matches type arguments typeArguments := LESS typeArgument (COMMA typeArgument)* GREATER
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - typeArgument
```
public String typeArgument()
                    throws org.antlr.runtime.RecognitionException
```
    Matches a type argument typeArguments := QUESTION (( EXTENDS | SUPER ) type )? | type ;
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - qualifiedIdentifier
```
public String qualifiedIdentifier()
                           throws org.antlr.runtime.RecognitionException
```
    Matches a qualified identifier qualifiedIdentifier := ID ( DOT ID )*
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - conditionalExpression
```
public String conditionalExpression()
                             throws org.antlr.runtime.RecognitionException
```
    Matches a conditional expression
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - conditionalOrExpression
```
public String conditionalOrExpression()
                               throws org.antlr.runtime.RecognitionException
```
    Matches a conditional || expression
    
    Returns:
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - chunk
```
public String chunk(int leftDelimiter,
                    int rightDelimiter,
                    int location)
```
    Matches a chunk started by the leftDelimiter and ended by the rightDelimiter.
    
    Specified by:
    
    chunk in interface DRLParser
    
    Parameters:
    
    leftDelimiter -
    
    rightDelimiter -
    
    location -
    
    Returns:
    
    the matched chunk without the delimiters
  - recoverFromMismatchedToken
```
protected org.antlr.runtime.Token recoverFromMismatchedToken(org.antlr.runtime.TokenStream input,
                                                             int ttype,
                                                             String text,
                                                             int[] follow)
                                                      throws org.antlr.runtime.RecognitionException
```
    Attempt to recover from a single missing or extra token. EXTRA TOKEN LA(1) is not what we are looking for. If LA(2) has the right token, however, then assume LA(1) is some extra spurious token. Delete it and LA(2) as if we were doing a normal match(), which advances the input. MISSING TOKEN If current token is consistent with what could come after ttype then it is ok to "insert" the missing token, else throw exception For example, Input "i=(3;" is clearly missing the ')'. When the parser returns from the nested call to expr, it will have call chain: stat -> expr -> atom and it will be trying to match the ')' at this point in the derivation: => ID '=' '(' INT ')' ('+' atom)* ';' ^ match() will see that ';' doesn't match ')' and report a mismatched token error. To recover, it sees that LA(1)==';' is in the set of tokens that can follow the ')' token reference in rule atom. It can assume that you forgot the ')'.
    
    Throws:
    
    org.antlr.runtime.RecognitionException
  - mismatchIsUnwantedToken
```
public boolean mismatchIsUnwantedToken(org.antlr.runtime.TokenStream input,
                                       int ttype,
                                       String text)
```
  - mismatchIsMissingToken
```
public boolean mismatchIsMissingToken(org.antlr.runtime.TokenStream input,
                                      int[] follow)
```

Class DRL5Parser

Field Summary

Fields inherited from class org.drools.compiler.lang.AbstractDRLParser

Constructor Summary

Method Summary

Methods inherited from class org.drools.compiler.lang.AbstractDRLParser

Methods inherited from class java.lang.Object

Methods inherited from interface org.drools.compiler.lang.DRLParser

Constructor Detail

DRL5Parser

Method Detail

getLanguageLevel

compilationUnit

packageStatement

statement

importStatement

globalStatement

declare

entryPointDeclaration

windowDeclaration

enumDeclaration

typeDeclaration

function

query

rule

attribute

defaultConsequence

namedConsequence

type

typeArguments

typeArgument

qualifiedIdentifier

conditionalExpression

conditionalOrExpression

chunk

recoverFromMismatchedToken

mismatchIsUnwantedToken

mismatchIsMissingToken