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

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
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
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

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

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.