com.pega.pegarules.pub.generator

Interface IAssemblyStreamSupport

All Superinterfaces:

FirstUseAssembler

public interface IAssemblyStreamSupport
extends FirstUseAssembler

IAssemblyStreamSupport

Version:

$Revision: 69724 $ $Date: 2013-09-24 15:19:02 -0400 (Tue, 24 Sep 2013) $

Author:

olsok

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
void	generateJSPFragment(java.lang.String aSource)
void	generateJSPFragment(java.lang.String aSource, java.lang.StringBuffer aErrors) For JSP elimination within auto generated controls, need to handle JSP snippets that might be embedded in labels.
void	getBinaryFileRef(java.lang.StringBuffer aOutput, java.lang.String aApp, java.lang.String aFileName) Emit a reference to a binary file (including its static content hash), processing runtime references for the application and name fields.
void	getBinaryFileRef(java.lang.StringBuffer aOutput, java.lang.String aApp, java.lang.String aPrimaryFileName, java.lang.String aAlternateFileName) Emit a reference to a binary file (including its static content hash), processing runtime references for the application and name fields.
void	getBinaryFileRefName(java.lang.StringBuffer aOutput, java.lang.String aApp, java.lang.String aFileName) Return a reference to a binary file (including its static content hash), processing runtime references for the application and name fields.
void	getBinaryFileRefName(java.lang.StringBuffer aOutput, java.lang.String aApp, java.lang.String aPrimaryFileName, java.lang.String aAlternateFileName) Return a reference to a binary file (including its static content hash), processing runtime references for the application and name fields.
IStaticContentAssembly	getStaticAssemblyBlock(java.lang.String aType, java.lang.StringBuffer aOutput) Obtain an instance of the static content assembly helper object.
IStaticContentAssembly	getStaticAssemblyBlock(java.lang.String aType, java.lang.StringBuffer aOutput, java.lang.String aId) Obtain an instance of the static content assembly helper object.
java.lang.String	getStreamWhenExpressionCode(ClipboardProperty aPropForMessages, java.lang.String aExpression) Returns a string of code to be inserted into an "if" statement that will evaluate aExpression at runtime.
void	includeStream(java.lang.String aName, java.lang.String aInputMode, java.lang.String aType, boolean aInline, java.lang.String aOnlyOnceName) Emit another stream rule, possibly inlined during assembly.
void	includeStreamRef(java.lang.String aNameRef, java.lang.String aInputMode, java.lang.String aType, java.lang.String aOnlyOnceName) Emit another stream rule, which will be evaluated at runtime.
boolean	isJSPCompilerNeeded() Resolves the settings made by setUsesJSP() and setUsesNoJSP() to determine if the JSP compiler must be invoked for this stream.
void	setUsesJSP() Call this method to specify that this (or an included stream) uses JSP directives and therefore must be processed by the JSP compiler.
void	setUsesNoJSP() Call this method to specify that no JSP tags are used and therefore processing by the JSP compiler may be bypassed as part of the GRP-39808 JSP bypass optimization logic.
boolean	validateWhen(ClipboardProperty aPropForMessages, java.lang.String aExpression) Validates aExpression for correct syntax (as handled by stream when expressions).
boolean	validateWhen(ClipboardProperty aPropForMessages, java.lang.String aExpression, java.lang.String aUseClassName) Validates aExpression for correct syntax (as handled by stream when expressions).

Methods inherited from interface com.pega.pegarules.pub.generator.FirstUseAssembler

addCode, addCode, addCode, addCode, addErrorMessages, addImport, addKnownPageDescriptor, addToSupport, addToSupport, addToSupport, checkModelInstance, checkWhenInstance, createMethod, createMethod, createPageDescriptor, createPageDescriptor, decreaseIndent, decreaseIndent, decreaseIndentAS, decreaseIndentAS, emit, emitAS, emitASconst, emitASconstln, emitAScsf, emitASln, emitASraw, emitCSF, emitCSFln, emitEscaped, emitEscapedln, emitln, focusOnSupport, generateJavaForPropertySet, generateStepPageReference, getBooleanCodeGenerator, getBooleanWithVariableCodeGenerator, getBuilder, getCaller, getClassForPage, getCodeGenerator, getCodeGeneratorInstance, getDatabase, getDefinition, getDictionary, getEditContext, getIdentification, getInThunkGeneration, getJavaBuilder, getJavaForExpression, getJavaForExpression, getJavaName, getJavaTypeForPegaType, getKeys, getLocalParameters, getMethodName, getMethodNameForKey, getPageDescriptor, getParameters, getPrimaryDescriptor, getRuleBasis, getStepPage, getStringCodeGenerator, getStringWithVariableCodeGenerator, getThread, getUniqueID, getWhenChangeDeclarativeReferences, getWillChangeDeclarativeReferences, haveRuleBasis, increaseIndent, increaseIndent, increaseIndentAS, increaseIndentAS, isDeclarativeInvoked, isDeclarativeRule, isEditing, isEmbedded, isMyStepPageChecked, isPrimary, isRuntime, newStringExpression, newStringExpression, newStringExpression, noInlining, noteClassDependence, noteInstanceUsed, noteInstanceUsed, notePropertyUsed, notePropertyUsed, openRule, popStepPage, preprocessExpression, preprocessExpression, pushStepPage, pushStepPage, resetDefaultDefinition, restoreFocus, setCurrentRepeatType, setDeclarativeInvoked, setDeclarativeRule, setIndentContent, setIndentContentAS, setIndentLevel, setIndentLevelAS, setMyStepPageChecked, setOverrideDefinition, setWhenChangeDeclarativeReferences, setWillChangeDeclarativeReferences, summarizeGeneratedMethods, translateCodeBlock, translateExpression, translateExpression

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

getBinaryFileRef

void getBinaryFileRef(java.lang.StringBuffer aOutput,
                    java.lang.String aApp,
                    java.lang.String aFileName)

Emit a reference to a binary file (including its static content hash), processing runtime references for the application and name fields. If the parameters are constant, the evaluation will occur during assembly and the static file reference will be emitted into the assembled rule. Otherwise a function reference will be emitted and the evaluation deferred until run-time.

Parameters:

aOutput - Buffer to which code to emit reference should be written, if null then output will be written using assembler.addCode(). Note that the output of this method is a full Java statement.

aApp - Application name (e.g. "webwb")

aFileName - Name of binary file - including file type.

getBinaryFileRef

void getBinaryFileRef(java.lang.StringBuffer aOutput,
                    java.lang.String aApp,
                    java.lang.String aPrimaryFileName,
                    java.lang.String aAlternateFileName)

Emit a reference to a binary file (including its static content hash), processing runtime references for the application and name fields. If the parameters are constant, the evaluation will occur during assembly and the static file reference will be emitted into the assembled rule. Otherwise a function reference will be emitted and the evaluation deferred until run-time.

Parameters:

aOutput - Buffer to which code to emit reference should be written, if null then output will be written using assembler.addCode(). Note that the output of this method is a full Java statement.

aApp - Application name (e.g. "webwb")

aPrimaryFileName - Name of binary file - including file type.

aAlternateFileName - Alternate name of binary file - including file type.

getBinaryFileRefName

void getBinaryFileRefName(java.lang.StringBuffer aOutput,
                        java.lang.String aApp,
                        java.lang.String aFileName)

Return a reference to a binary file (including its static content hash), processing runtime references for the application and name fields. If it can be inlined, the evaluation will occur during assembly and the static file reference will be returned. Otherwise a function reference will be returned for evaluation at run-time.

Parameters:

aOutput - Buffer holding the code. Note that the output of this method is a full Java statement.

aApp - Application name (e.g. "webwb")

aFileName - Name of binary file - including file type.

getBinaryFileRefName

void getBinaryFileRefName(java.lang.StringBuffer aOutput,
                        java.lang.String aApp,
                        java.lang.String aPrimaryFileName,
                        java.lang.String aAlternateFileName)

Return a reference to a binary file (including its static content hash), processing runtime references for the application and name fields. If it can be inlined, the evaluation will occur during assembly and the static file reference will be returned. Otherwise a function reference will be returned for evaluation at run-time.

Parameters:

aOutput - Buffer holding the code. Note that the output of this method is a full Java statement.

aApp - Application name (e.g. "webwb")

aPrimaryFileName - Name of binary file - including file type.

aAlternateFileName - Alternate name of binary file - including file type.

includeStream

void includeStream(java.lang.String aName,
                 java.lang.String aInputMode,
                 java.lang.String aType,
                 boolean aInline,
                 java.lang.String aOnlyOnceName)

Emit another stream rule, possibly inlined during assembly.

Parameters:

aName - Name of stream rule to include, must a constant value at assembly time.

aInputMode - "Input", "NoInput" or null

aType - pxObjClass value, "standard", "Input" or "NoInput"

aInline - false to force the stream to be evaluated at runtime

aOnlyOnceName - null or name controlling output of stream only once during an interaction. If multiple streams are controlled by the same name, use null here and if (pzAuto.doOnlyOnce(name)) {multiple-include-stream calls} to control output.

includeStreamRef

void includeStreamRef(java.lang.String aNameRef,
                    java.lang.String aInputMode,
                    java.lang.String aType,
                    java.lang.String aOnlyOnceName)

Emit another stream rule, which will be evaluated at runtime.

Parameters:

aNameRef - Name of stream rule to include, may contain references to stream variables.

aInputMode - "Input", "NoInput" or null

aType - pxObjClass value, "standard", "Input" or "NoInput"

aOnlyOnceName - null or name controlling output of stream only once during an interaction. If multiple streams are controlled by the same name, use null here and if (pzAuto.doOnlyOnce(name)) {multiple-include-stream calls} to control output.

getStaticAssemblyBlock

IStaticContentAssembly getStaticAssemblyBlock(java.lang.String aType,
                                            java.lang.StringBuffer aOutput)

Obtain an instance of the static content assembly helper object.

Parameters:

aType - must be "script" or "style"

aOutput - the StringBuffer into which assembled code should be placed, specify null to use the current assembly output buffer.

Returns:

instance of static assembly helper

getStaticAssemblyBlock

IStaticContentAssembly getStaticAssemblyBlock(java.lang.String aType,
                                            java.lang.StringBuffer aOutput,
                                            java.lang.String aId)

Obtain an instance of the static content assembly helper object.

Parameters:

aType - must be "script" or "style"

aOutput - the StringBuffer into which assembled code should be placed, specify null to use the current assembly output buffer.

aId - Specify a unique Java identifier value to be used to construct a run-time variable name to reference the static assembly block (for example, the OnlyOnce tag associated with the static block). Use null to have a value generated. This parameter is provided for use within separately generated methods where it is easy for the caller to track an identifier and there is a desire to have identical generated methods consolidated.

Returns:

instance of static assembly helper

setUsesJSP

void setUsesJSP()

Call this method to specify that this (or an included stream) uses JSP directives and therefore must be processed by the JSP compiler. This will override any other indications that the JSP compiler may be bypassed as part of the GRP-39808 JSP bypass optimization logic. (Intended as a "safety mechanism" for included or nested elements to report back that they use JSP tags.)

setUsesNoJSP

void setUsesNoJSP()

Call this method to specify that no JSP tags are used and therefore processing by the JSP compiler may be bypassed as part of the GRP-39808 JSP bypass optimization logic.

isJSPCompilerNeeded

boolean isJSPCompilerNeeded()

Resolves the settings made by setUsesJSP() and setUsesNoJSP() to determine if the JSP compiler must be invoked for this stream.

Returns:

true if the JSP compiler must be invoked.

generateJSPFragment

void generateJSPFragment(java.lang.String aSource,
                       java.lang.StringBuffer aErrors)

For JSP elimination within auto generated controls, need to handle JSP snippets that might be embedded in labels.

Parameters:

aSource - JSP source to process

aErrors - optional StringBuffer into which any errors will be placed

generateJSPFragment

void generateJSPFragment(java.lang.String aSource)

validateWhen

boolean validateWhen(ClipboardProperty aPropForMessages,
                   java.lang.String aExpression)

Validates aExpression for correct syntax (as handled by stream when expressions). Any warnings or errors will be attached to the property specified, or if null, to the defining page of the assembly. When called during editing, rule referencing information is captured on the defining page of the assembly for When rule and Property references.

As an example consider this fragment from the R-U-Function GenerateButton(ClipboardProperty, String, boolean, int, boolean, ClipboardPage).
Old usage: thisButtonString.append("if(com.pega.pegarules.jsptags.WhenTag.evaluateWhen(pega, \"" + StringUtils.escapeIntoJavaString(visibleWhen) + "\",null, true)) {");
New usage: assembler.validateWhen(cp_thisButton, visibleWhen); thisButtonString.append("if(" + assembler.getStreamWhenExpressionCode(null, visibleWhen) + ") {");

Parameters:

aPropForMessages -

aExpression -

Returns:

true if the expression is valid

validateWhen

boolean validateWhen(ClipboardProperty aPropForMessages,
                   java.lang.String aExpression,
                   java.lang.String aUseClassName)

Validates aExpression for correct syntax (as handled by stream when expressions). Any warnings or errors will be attached to the property specified, or if null, to the defining page of the assembly. When called during editing, rule referencing information is captured on the defining page of the assembly for When rule and Property references.

As an example consider this fragment from the R-U-Function GenerateButton(ClipboardProperty, String, boolean, int, boolean, ClipboardPage).
Old usage: thisButtonString.append("if(com.pega.pegarules.jsptags.WhenTag.evaluateWhen(pega, \"" + StringUtils.escapeIntoJavaString(visibleWhen) + "\",null, true)) {");
New usage: assembler.validateWhen(cp_thisButton, visibleWhen); thisButtonString.append("if(" + assembler.getStreamWhenExpressionCode(null, visibleWhen) + ") {");

Parameters:

aPropForMessages -

aExpression -

aUseClassName - class name to be used to resolve relative property references

Returns:

true if the expression is valid

getStreamWhenExpressionCode

java.lang.String getStreamWhenExpressionCode(ClipboardProperty aPropForMessages,
                                           java.lang.String aExpression)

Returns a string of code to be inserted into an "if" statement that will evaluate aExpression at runtime. This string may consist of:

• a call to pzAuto.evaluateCompiledWhen()
• a call to pzAuto.evaluateWhen()
• in-line code if the expression was a jsp scriptlet or "@java()" function
• (future) in-line code for some simple expressions

As an example consider this fragment from the R-U-Function GenerateButton(ClipboardProperty, String, boolean, int, boolean, ClipboardPage).
Old usage: thisButtonString.append("if(com.pega.pegarules.jsptags.WhenTag.evaluateWhen(pega, \"" + StringUtils.escapeIntoJavaString(visibleWhen) + "\",null, true)) {");
New usage: thisButtonString.append("if(" + assembler.getStreamWhenExpressionCode(null, visibleWhen) + ") {");

Parameters:

aPropForMessages -

aExpression -

Returns:

String of code to be inserted into an "if" statement.