public abstract class

AbstractDiagnosticsTransform

extends AbstractAdminTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractAppTransform
			↳	com.microstrategy.web.admin.transforms.AbstractAdminTransform
				↳	com.microstrategy.web.admin.transforms.AbstractDiagnosticsTransform

Known Direct Subclasses

DiagnosticsPropertiesTransform, DiagnosticsStatisticsTransform, DiagnosticsViewerTransform

Class Overview

Title: AbstractDiagnosticsTransform This abstact class can be used as base for the different transforms related with the Diagnostics feature.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.transforms.AbstractAppTransform

Fields
protected String	_imgLeftCorner	Image to use for the left corner of the header to display.
protected String	_imgRightCorner	Image to use for the right corner of the header to display
protected String	cssGlobal	This property keeps the css style class name to use globally on the interface to display to the user.
protected String	cssHeaderTable	This property keeps the css style class name to use for the main header to display on the interface.
protected String	cssMainTableHeading	This property keeps the css style class name to use for the table that will hold the table heading to display to the user.

[Expand]

Inherited Fields

From class com.microstrategy.web.admin.transforms.AbstractAdminTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	AbstractDiagnosticsTransform() Class constructor, initializes formal parameters.

Public Methods
Class	getSupportedBeanType() Returns the supported bean type.
void	initializeCss() Initialize the css classes to use while displaying this transform
void	initializeImages() Initializes the images to be used by this transform
void	initializeTransform(Transformable data) This method initializes the private and protected fields of the transform.
abstract void	renderDiagnosticOutput(MarkupOutput out) Generate the output the transform instance is to generate for the `DiagnosticsBean` bean.
void	renderDialogHeader(MarkupOutput out) Render the main dialog header to display to the user on the page
void	transformForRequestSuccessful(MarkupOutput out) Transform when the status of the bean which is transformed by this transform is `WebBeanRequestSuccessful`

Protected Methods
WebEvent	getApplyDiagnosticsEvent(DiagnosticsBean bean) Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.
String	getArgumentName(WebEvent event, int argumentId) Get the name of the argument assigned to the `WebEvent`, based on the indicated id.
DiagnosticsBean	getDiagnosticsBean() Returns the current `DiagnosticsBean` instance being transformed
WebEvent	getLoadDefaultsEvent(DiagnosticsBean bean) Generate the event that will be used for loading the default values of the diagnostics configuration specified on the form.
abstract String	getTitle() Returns the title for the interface to display
void	renderSubmitButtons(MarkupOutput out, WebEvent applyDiagnostics, WebEvent loadDefaults, String applyString, String loadString) Display the submit buttons corresponding to the saveDiagnostics event

[Expand]

Inherited Methods

From class com.microstrategy.web.admin.transforms.AbstractAdminTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

From class com.microstrategy.web.transform.AbstractLayoutTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

From class java.lang.Object

From interface com.microstrategy.web.app.transforms.AppTransform

From interface com.microstrategy.web.transform.Transform

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Fields

protected String _imgLeftCorner

Image to use for the left corner of the header to display.

protected String _imgRightCorner

Image to use for the right corner of the header to display

protected String cssGlobal

This property keeps the css style class name to use globally on the interface to display to the user.

protected String cssHeaderTable

This property keeps the css style class name to use for the main header to display on the interface.

protected String cssMainTableHeading

This property keeps the css style class name to use for the table that will hold the table heading to display to the user.

Public Constructors

public AbstractDiagnosticsTransform ()

Class constructor, initializes formal parameters.

Public Methods

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports DiagnosticsBean instances

Returns

DiagnosticBean.class

public void initializeCss ()

Initialize the css classes to use while displaying this transform

public void initializeImages ()

Initializes the images to be used by this transform

public void initializeTransform (Transformable data)

This method initializes the private and protected fields of the transform. It also invokes the initializeImages() and initializeCss() methods and re-defines the values for the cssFile and cssPrefix formal parameters.

Parameters

data	the `Transformable` data representing the bean that this instance is going to transform.

public abstract void renderDiagnosticOutput (MarkupOutput out)

Generate the output the transform instance is to generate for the DiagnosticsBean bean.

Parameters

out	`MarkupOutput` instance where the contents to display by this transform are to be saved

public void renderDialogHeader (MarkupOutput out)

Render the main dialog header to display to the user on the page

Parameters

out	`MarkupOutput` instance where the HTML to display will be saved

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status of the bean which is transformed by this transform is WebBeanRequestSuccessful

Parameters

out	`MarkupOutput` instance where the contents to display by this transform are to be saved

Protected Methods

protected WebEvent getApplyDiagnosticsEvent (DiagnosticsBean bean)

Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.

Parameters

bean	`DiagnosticsBean` being transformed

Returns

a WebEvent with the corresponding event, null if the application does not support it.

protected String getArgumentName (WebEvent event, int argumentId)

Get the name of the argument assigned to the WebEvent, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.

Parameters

event	`WebEvent` from where the argument name will be retrieved
argumentId	`int` with the identifier of the argument to search for on the event

Returns

the corresponding name of the event for the specified id. If it is not found, it will return null.

protected DiagnosticsBean getDiagnosticsBean ()

Returns the current DiagnosticsBean instance being transformed

Returns

the DiagnosticsBean instance associated with this transform.

protected WebEvent getLoadDefaultsEvent (DiagnosticsBean bean)

Generate the event that will be used for loading the default values of the diagnostics configuration specified on the form.

Parameters

bean	`DiagnosticsBean` being transformed

Returns

a WebEvent with the corresponding event, null if the application does not support it.

protected abstract String getTitle ()

Returns the title for the interface to display

Returns

the text to display as title of the transform

protected void renderSubmitButtons (MarkupOutput out, WebEvent applyDiagnostics, WebEvent loadDefaults, String applyString, String loadString)

Display the submit buttons corresponding to the saveDiagnostics event

Parameters

out	`MarkupOutput` instance to modify
applyDiagnostics	`WebEvent` instance with the initialized event for applying the properties
loadDefaults	`WebEvent` instance with the initialized event for loading the original default values of the properties
applyString	`String` with the descriptor for the button that will be used for applying the changes on the form.
loadString	`String` with the descriptor for the button that will be used for loading default values on the form.

Classes

AbstractDiagnosticsTransform

Class Overview

Summary

Fields

protected String _imgLeftCorner

protected String _imgRightCorner

protected String cssGlobal

protected String cssHeaderTable

protected String cssMainTableHeading

Public Constructors

public AbstractDiagnosticsTransform ()

Public Methods

public Class getSupportedBeanType ()

Returns

public void initializeCss ()

public void initializeImages ()

public void initializeTransform (Transformable data)

Parameters

public abstract void renderDiagnosticOutput (MarkupOutput out)

Parameters

public void renderDialogHeader (MarkupOutput out)

Parameters

public void transformForRequestSuccessful (MarkupOutput out)

Parameters

Protected Methods

protected WebEvent getApplyDiagnosticsEvent (DiagnosticsBean bean)

Parameters

Returns

protected String getArgumentName (WebEvent event, int argumentId)

Parameters

Returns

protected DiagnosticsBean getDiagnosticsBean ()

Returns

protected WebEvent getLoadDefaultsEvent (DiagnosticsBean bean)

Parameters

Returns

protected abstract String getTitle ()

Returns

protected void renderSubmitButtons (MarkupOutput out, WebEvent applyDiagnostics, WebEvent loadDefaults, String applyString, String loadString)

Parameters