CodeGenerator (PegaRULES Java Engine v7.4.0

```
public interface CodeGenerator
```
CodeGenerator

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT`
`static int`	`TYPE_CLIPBOARD_PROPERTY` The constant variable to hold the code for the type clipboard property
`static int`	`TYPE_LOCAL` The constant variable to hold the code for the type local
`static int`	`TYPE_PARAM` The constant variable to hold the code for the type param
`static int`	`TYPE_VALUE` The constant variable to hold the code for the type value
`static java.lang.String`	`VERSION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getAvoidJavaPropertyLookup()` Gets the flag that indicates that Java property lookup should be avoided during getIfPresent of property.
`ClassInfo`	`getClassInfo()` Returns the class info (that contains this property).
`java.util.List`	`getDeclarativeReferences()` get list of declarative references
`java.lang.String`	`getDiagnosticPrimary()` Returns the diagnostic copy of the Primary buffer
`java.util.List`	`getErrorMessages()` Returns the error messages resulting from translating an expression.
`java.lang.String`	`getErrorMessagesAsString(boolean aFormatted, boolean aEscapeQuotes)` returns the error messages as a String
`boolean`	`getForcePAndCLookup()` Gets the setting that forces lookup of relative references in Pages & Classes
`int`	`getGeneratedType()` Returns the generated type of the translated expression.
`boolean`	`getHasUnresolvedAssemblyError()` retrieve flag that indicates parser inserted an UnresolvedAssemblyError statement in the code.
`java.lang.String`	`getJavaType()` Returns the mJavaType.
`char`	`getMode()` Returns the mMode.
`boolean`	`getMustHaveVariable()` retrieve the indicator that the caller wants to force the generation of an intermediate variable for this expression.
`char`	`getPegaType()` Returns the Pega type of the translated expression.
`java.lang.String`	`getPegaTypeName()` Returns the mPegaType.
`java.lang.String`	`getPrimary()` Returns the mPrimary.
`java.lang.String`	`getPropertyInfoName()` return the qualified PropertyInfo.TYPE_xxx name for the type
`ImmutablePropertyInfo`	`getPropInfo()` Returns the mPropInfo.
`java.lang.String`	`getPropName()` Returns the name of this property.
`boolean`	`getRefNameOnly()` parse reference name only -- for step page name parse
`java.lang.String`	`getSecondary()` Returns the mSecondary.
`java.lang.String`	`getTertiary()` Returns the mTertiary.
`boolean`	`getUseIfPresent()` Gets the flag that indicates that getIfPresent should be used instead of getProperty to resolve property references.
`boolean`	`isTertiaryVariableNameOnly()`
`void`	`setAvoidJavaPropertyLookup(boolean aAvoidJavaPropertyLookup)` Sets the flag that indicates that Java property lookup should be avoided during getIfPresent of property.
`void`	`setForcePAndCLookup(boolean aForcePAndCLookup)` Sets the flag that indicates that the embedded expression contains a relative reference that MUST be looked up in Pages & Classes.
`void`	`setGeneratedType(int aGeneratedType)` Sets the generated type.
`void`	`setJavaType(java.lang.String aJavaType)` Sets the expected JavaType.
`void`	`setMode(char aMode)` Sets the expected Mode.
`void`	`setMustHaveVariable(boolean aValue)` set the indicator that the caller wants to force the generation of an intermediate variable for this expression.
`void`	`setPegaType(char aPegaType)` Sets the expected pega type using a PropertyInfo type code
`void`	`setPegaType(java.lang.String aPegaType)` Sets the expected pega type using a type name
`void`	`setRefNameOnly(boolean aValue)` parse reference name only -- for step page name parse
`void`	`setUseIfPresent(boolean aUseIfPresent)` Sets the flag that requests the expression code generator to use getIfPresent instead of getProperty to resolve property references.
`java.lang.String`	`toString()` Return a string (for debugging) that contains content of this instance.

- Field Detail
  - VERSION
```
static final java.lang.String VERSION
```
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    See Also:
    
    Constant Field Values
  - TYPE_CLIPBOARD_PROPERTY
```
static final int TYPE_CLIPBOARD_PROPERTY
```
    The constant variable to hold the code for the type clipboard property
    
    See Also:
    
    Constant Field Values
  - TYPE_LOCAL
```
static final int TYPE_LOCAL
```
    The constant variable to hold the code for the type local
    
    See Also:
    
    Constant Field Values
  - TYPE_PARAM
```
static final int TYPE_PARAM
```
    The constant variable to hold the code for the type param
    
    See Also:
    
    Constant Field Values
  - TYPE_VALUE
```
static final int TYPE_VALUE
```
    The constant variable to hold the code for the type value
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getErrorMessages
```
java.util.List getErrorMessages()
```
    Returns the error messages resulting from translating an expression.
    
    Returns:
    
    the list of error messages
  - getErrorMessagesAsString
```
java.lang.String getErrorMessagesAsString(boolean aFormatted,
                                          boolean aEscapeQuotes)
```
    returns the error messages as a String
    
    Parameters:
    
    aFormatted - true if messages should be formatted using Rule-Message, false for raw, newline delimited messages
    
    aEscapeQuotes - true if quotations should be escaped so that message may itself be used within a quoted string
    
    Returns:
    
    non-null String (zero length if no errors)
  - getGeneratedType
```
int getGeneratedType()
```
    Returns the generated type of the translated expression.
    
    Returns:
    
    the generated type, as one of the TYPE_ constants
  - getJavaType
```
java.lang.String getJavaType()
```
    Returns the mJavaType.
    
    Returns:
    
    char the java type
  - getMode
```
char getMode()
```
    Returns the mMode.
    
    Returns:
    
    int the mode
  - getPegaType
```
char getPegaType()
```
    Returns the Pega type of the translated expression.
    
    Returns:
    
    the Pega type, as one of the TYPE_ constants of PropertyInfo
  - getPegaTypeName
```
java.lang.String getPegaTypeName()
```
    Returns the mPegaType.
    
    Returns:
    
    String the name of the pega type
  - getPropertyInfoName
```
java.lang.String getPropertyInfoName()
```
    return the qualified PropertyInfo.TYPE_xxx name for the type
    
    Returns:
    
    the qualified PropertyInfo.TYPE_xxx name for the type
  - getPrimary
```
java.lang.String getPrimary()
```
    Returns the mPrimary.
    
    Returns:
    
    StringBuffer the primary buffer
  - getSecondary
```
java.lang.String getSecondary()
```
    Returns the mSecondary.
    
    Returns:
    
    StringBuffer the secondaty buffer
  - getTertiary
```
java.lang.String getTertiary()
```
    Returns the mTertiary.
    
    Returns:
    
    StringBuffer the tertiary buffer
  - getPropInfo
```
ImmutablePropertyInfo getPropInfo()
```
    Returns the mPropInfo.
    
    Returns:
    
    PropertyInfo the property info
  - getClassInfo
```
ClassInfo getClassInfo()
```
    Returns the class info (that contains this property).
    
    Returns:
    
    the class info
  - getPropName
```
java.lang.String getPropName()
```
    Returns the name of this property.
    
    Returns:
    
    property name
  - getMustHaveVariable
```
boolean getMustHaveVariable()
```
    retrieve the indicator that the caller wants to force the generation of an intermediate variable for this expression. (allows When blocks to compute the expression once and use the result both as the value of the When and as an epilog parameter)
    
    Returns:
    
    true if an intermediate variable is required
  - getDiagnosticPrimary
```
java.lang.String getDiagnosticPrimary()
```
    Returns the diagnostic copy of the Primary buffer
    
    Returns:
    
    StringBuffer the primary buffer
  - getRefNameOnly
```
boolean getRefNameOnly()
```
    parse reference name only -- for step page name parse
    
    Returns:
    
    value
  - getHasUnresolvedAssemblyError
```
boolean getHasUnresolvedAssemblyError()
```
    retrieve flag that indicates parser inserted an UnresolvedAssemblyError statement in the code.
    
    Returns:
    
    true if parser generated UnresolvedAssemblyError
  - getDeclarativeReferences
```
java.util.List getDeclarativeReferences()
```
    get list of declarative references
    
    Returns:
    
    List
  - setRefNameOnly
```
void setRefNameOnly(boolean aValue)
```
    parse reference name only -- for step page name parse
    
    Parameters:
    
    aValue -
  - setMustHaveVariable
```
void setMustHaveVariable(boolean aValue)
```
    set the indicator that the caller wants to force the generation of an intermediate variable for this expression. (allows When blocks to compute the expression once and use the result both as the value of the When and as an epilog parameter)
    
    Parameters:
    
    aValue - true if an intermediate variable is required
  - setJavaType
```
void setJavaType(java.lang.String aJavaType)
```
    Sets the expected JavaType.
    
    Parameters:
    
    aJavaType - the JavaType to set
  - setMode
```
void setMode(char aMode)
```
    Sets the expected Mode.
    
    Parameters:
    
    aMode - the aMode to set
  - setPegaType
```
void setPegaType(char aPegaType)
```
    Sets the expected pega type using a PropertyInfo type code
    
    Parameters:
    
    aPegaType - the pega type to set
  - setPegaType
```
void setPegaType(java.lang.String aPegaType)
```
    Sets the expected pega type using a type name
    
    Parameters:
    
    aPegaType - the pega type to set
  - toString
```
java.lang.String toString()
```
    Return a string (for debugging) that contains content of this instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String of debug information.
  - getUseIfPresent
```
boolean getUseIfPresent()
```
    Gets the flag that indicates that getIfPresent should be used instead of getProperty to resolve property references.
    
    Returns:
    
    true if somePage.getIfPresent is in use
  - setUseIfPresent
```
void setUseIfPresent(boolean aUseIfPresent)
```
    Sets the flag that requests the expression code generator to use getIfPresent instead of getProperty to resolve property references.
    
    Parameters:
    
    aUseIfPresent - true if somePage.getIfPresent should be used.
  - getAvoidJavaPropertyLookup
```
boolean getAvoidJavaPropertyLookup()
```
    Gets the flag that indicates that Java property lookup should be avoided during getIfPresent of property.
    
    Returns:
    
    true if the flag is true iff somePage.getIfPresent is being used.
  - setAvoidJavaPropertyLookup
```
void setAvoidJavaPropertyLookup(boolean aAvoidJavaPropertyLookup)
```
    Sets the flag that indicates that Java property lookup should be avoided during getIfPresent of property. This flag is applicable only if UseIfPresent is true.
    
    Parameters:
    
    aAvoidJavaPropertyLookup -
  - setGeneratedType
```
void setGeneratedType(int aGeneratedType)
```
    Sets the generated type. Allowed values are CodeGenerator.TYPE_* values
    
    Parameters:
    
    aGeneratedType - the generated type to set
  - setForcePAndCLookup
```
void setForcePAndCLookup(boolean aForcePAndCLookup)
```
    Sets the flag that indicates that the embedded expression contains a relative reference that MUST be looked up in Pages & Classes. Note: absolute references are searched in Pages & Classes by default.
    
    Parameters:
    
    aForcePAndCLookup - true iff the flag should be set to true
  - getForcePAndCLookup
```
boolean getForcePAndCLookup()
```
    Gets the setting that forces lookup of relative references in Pages & Classes
    
    Returns:
    
    true if this relative reference MUST be looked up Pages and classes.
  - isTertiaryVariableNameOnly
```
boolean isTertiaryVariableNameOnly()
```
    Returns:
    
    true if the tertiary buffer contains only a variable name.

Interface CodeGenerator

Field Summary

Method Summary

Field Detail

VERSION

COPYRIGHT

TYPE_CLIPBOARD_PROPERTY

TYPE_LOCAL

TYPE_PARAM

TYPE_VALUE

Method Detail

getErrorMessages

getErrorMessagesAsString

getGeneratedType

getJavaType

getMode

getPegaType

getPegaTypeName

getPropertyInfoName

getPrimary

getSecondary

getTertiary

getPropInfo

getClassInfo

getPropName

getMustHaveVariable

getDiagnosticPrimary

getRefNameOnly

getHasUnresolvedAssemblyError

getDeclarativeReferences

setRefNameOnly

setMustHaveVariable

setJavaType

setMode

setPegaType

setPegaType

toString

getUseIfPresent

setUseIfPresent

getAvoidJavaPropertyLookup

setAvoidJavaPropertyLookup

setGeneratedType

setForcePAndCLookup

getForcePAndCLookup

isTertiaryVariableNameOnly