com.pega.pegarules.pub.context

Interface PRStackFrame

public interface PRStackFrame

The PRStackFrame interface serves primarily to provide a logical stack-trace capability. Additionally, each instance encapsulates the context information for one processing step during execution:

• String descriptor for this processing step
• current ParameterPage
• current Primary Page
• current Step Page
• current Step Status

Any PRStackFrame instance becomes inactive at the end of the processing step it represents, and can no longer be used for processing. But even an inactive instance can be used to trace the sequence of stack frames that led to its creation.

Version:

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

Author:

John van der Meer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PRStackFrame.Type Represents the type of stack frame.

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
java.lang.String	getLabel() Deprecated. Calling getLabel is expensive causing the label to be constructed from its parts. The label is now meant to be used for tracing and log information. Code should use the Type to determine the kind of stack label. (Feel free to add new Types). In addition, rather than getting the label and parsing its substrings, use getLabelVariable() to get the sub-string which are being used to construct the label.
java.lang.String	getLabelVariable(int aIndex)
PRStackFrame	getNext() Identifies the stack frame, if any, that is executing immediately within this one.
StringMap	getParameterPage() Identifies the ParameterPage of this stack frame.
PRStackFrame	getPrevious() Identifies the stack frame from which the current instance was created.
ClipboardPage	getPrimaryPage() Identifies the Primary Page of this stack frame.
PRStackFrame	getRootOfStack() Locates the root (first) frame of the stack that includes this instance.
ProcessingStatus	getStatus() Identifies the Step Status of this stack frame.
ClipboardPage	getStepPage() Identifies the Step Page of this stack frame.
PRStackFrame	getTopOfStack() Locates the frame at the top of the stack that includes (or included) this instance.
PRStackFrame.Type	getType() Identifies the type of this stack frame.
boolean	isActive() Indicates whether this instance is active, that is, whether it is still part of an execution stack.
boolean	isRoot() Indicates whether this instance is the root (first) frame of an execution stack.
boolean	isTop() Indicates whether this instance is currently the top frame of an execution stack.
void	setParameterPage(StringMap aNewPage) Identifies the new ParameterPage of this stack frame.

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

getRootOfStack

PRStackFrame getRootOfStack()

Locates the root (first) frame of the stack that includes this instance. Note that the root for this frame can be found even if the frame itself is no longer active.

Returns:

root instance of this stack

getTopOfStack

PRStackFrame getTopOfStack()

Locates the frame at the top of the stack that includes (or included) this instance. The current top-of-stack can be found even if this instance is inactive.

Returns:

instance currently at the top of the associated stack

getPrevious

PRStackFrame getPrevious()

Identifies the stack frame from which the current instance was created.

Returns:

caller stack frame, or null if this is the root frame

getNext

PRStackFrame getNext()

Identifies the stack frame, if any, that is executing immediately within this one.

Returns:

called stack frame, or null if this frame is at the top of the stack (or is inactive)

getType

PRStackFrame.Type getType()

Identifies the type of this stack frame. See enumerated Types below.

Returns:

the type specified when this instance was initialized

getLabel

java.lang.String getLabel()

Deprecated. Calling getLabel is expensive causing the label to be constructed from its parts. The label is now meant to be used for tracing and log information. Code should use the Type to determine the kind of stack label. (Feel free to add new Types). In addition, rather than getting the label and parsing its substrings, use getLabelVariable() to get the sub-string which are being used to construct the label.

Identifies the label of this stack frame.

Returns:

the label specified when this instance was created

getLabelVariable

java.lang.String getLabelVariable(int aIndex)

getParameterPage

StringMap getParameterPage()

Identifies the ParameterPage of this stack frame.

Returns:

the ParameterPage or StringMap specified when this instance was created (or updated)

getPrimaryPage

ClipboardPage getPrimaryPage()

Identifies the Primary Page of this stack frame.

Returns:

the Primary Page of this stack frame

getStepPage

ClipboardPage getStepPage()

Identifies the Step Page of this stack frame.

Returns:

the Step Page specified when this instance was created

getStatus

ProcessingStatus getStatus()

Identifies the Step Status of this stack frame.

Returns:

the Step Status of this stack frame

isActive

boolean isActive()

Indicates whether this instance is active, that is, whether it is still part of an execution stack.

Returns:

true if this instance is active; false otherwise

isRoot

boolean isRoot()

Indicates whether this instance is the root (first) frame of an execution stack.

Returns:

true if this is a root instance; false otherwise

isTop

boolean isTop()

Indicates whether this instance is currently the top frame of an execution stack.

Returns:

true if this instance is at the top of a stack; false otherwise

setParameterPage

void setParameterPage(StringMap aNewPage)

Identifies the new ParameterPage of this stack frame. May be any class that implements StringMap, including ParameterPage or ClipboardPage.

Parameters:

aNewPage -