public class

DiagnosticsViewerTransform

extends AbstractDiagnosticsTransform

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
					↳	com.microstrategy.web.admin.transforms.DiagnosticsViewerTransform

Class Overview

Title DiagnosticsViewerTransform This class is used to view diagnostic log contents which are applicable to all servers

Summary

[Expand]

Inherited Constants

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

[Expand]

Inherited Fields

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

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
	DiagnosticsViewerTransform() Class constructor, initializes formal parameters.

Public Methods
String	getDescription() Returns the description of this transform
void	initializeCss() Initializes the Css Classes to use.
void	renderDateComboBoxes(MarkupOutput out, LocaleInfo locale, String label, String paramDay, String paramMonth, String paramYear, int day, int month, int year, boolean hasError) Display the requested date combo box inside two TD cells (therefore, the parent TR and TABLE should be already opened).
void	renderDateViewingOptionsRow(MarkupOutput out, WebEvent applyEvent) Append to the MarkupOutput the rows and cells with the TO and FROM information for filtering the log contents.
void	renderDiagnosticOutput(MarkupOutput out) Generates the graphical output for the DiagnosticsBean, which for this transform's definition, will consist on an option box for the user to select which information s/he wants to read, plus a list of the logs recorded that are within the search parameters specified.
void	renderDisplayViewingOptionsRow(MarkupOutput out, WebEvent applyEvent) Show the options for viewing the log: which type of messages to see and from which date to which.
void	renderFormHiddenInputs(MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaults) Add to the global output any hidden inputs that should be rendered for the proper functionality of the form
void	renderIncrementalFetch(MarkupOutput out, int pageNumber, int low, int up, int total, int pageSize) Add the incremental fetch information given the information passed as parameters
boolean	renderLogFile(MarkupOutput out, DOMSupport domSupport, Document errorsXML) Show the log file contents, according to the specified filters and sorting
void	renderViewerError(MarkupOutput out, String message) Display any error message found while processing the log files
void	renderViewerOptions(MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaultsEvent, DiagnosticsBean bean) Render the interface that shows the user the different options for viewing the log contents: type of logs and dates to cover.

Protected Methods
AnchorTag	generateAnchor(WebEvent event) Overwrites the parent method by setting the typical url information on the link (thus disabling any default onclick definition)
WebEvent	getApplyDiagnosticsEvent(DiagnosticsBean bean) Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.
WebEvent	getSortEvent(DiagnosticsBean bean) Get the event to use for sorting the contents of the diagnostics file.
String	getSortImage(int sort) This method is deprecated. This method is no longer used. Use CSS classes via getSortImageCss(int sort)
String	getSortImageCss(int sort) Get the image css to render based on the current sort mode.
String	getTitle() Returns the title for the interface to display
void	setSortOrderEvent(WebEvent event, int sortOrder) Sets the event to execute the indicated sort if requested.

[Expand]

Inherited Methods

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

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.

Public Constructors

public DiagnosticsViewerTransform ()

Class constructor, initializes formal parameters.

Public Methods

public String getDescription ()

Returns the description of this transform

Returns

String value with the description of this transform

public void initializeCss ()

Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.

public void renderDateComboBoxes (MarkupOutput out, LocaleInfo locale, String label, String paramDay, String paramMonth, String paramYear, int day, int month, int year, boolean hasError)

Display the requested date combo box inside two TD cells (therefore, the parent TR and TABLE should be already opened).

Parameters

out	MarkupOutput instance to modify
locale	LocaleInfo instance, for getting the mm-dd-yy format (default)
label	The label to display next to the combo boxes
paramDay	name of the day parameter
paramMonth	name of the month parameter
paramYear	name of the year parameter
day	current day
month	current month
year	current year
hasError	boolean value indicating if the information to render has an error

public void renderDateViewingOptionsRow (MarkupOutput out, WebEvent applyEvent)

Append to the MarkupOutput the rows and cells with the TO and FROM information for filtering the log contents.
The contents generated by this method are inside several TR tags with two columns, therefore the parent TABLE should be already opened. By default the caller renderViewerOptions() takes care of it.

Parameters

out	the `MarkupOutput` to modify
applyEvent	`WebEvent` instance with the information for applying the options displayed here

public void renderDiagnosticOutput (MarkupOutput out)

Generates the graphical output for the DiagnosticsBean, which for this transform's definition, will consist on an option box for the user to select which information s/he wants to read, plus a list of the logs recorded that are within the search parameters specified.

Parameters

out	`MarkupOutput` instance where to create the HTML output

public void renderDisplayViewingOptionsRow (MarkupOutput out, WebEvent applyEvent)

Show the options for viewing the log: which type of messages to see and from which date to which.
The contents generated by this method are inside several TR tags with two columns, therefore the parent TABLE should be already opened. By default the caller renderViewerOptions() takes care of it.

Parameters

out	`MarkupOutput` instance that contains the HTML to display
applyEvent	`WebEvent` instance with the information for applying the options displayed here

public void renderFormHiddenInputs (MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaults)

Add to the global output any hidden inputs that should be rendered for the proper functionality of the form

Parameters

out	`MarkupOutput` instance where the HTML contents are to be saved.
applyEvent	`WebEvent` for applying the changes indicated on the form
loadDefaults	`WebEvent` for loading the default values on the form

public void renderIncrementalFetch (MarkupOutput out, int pageNumber, int low, int up, int total, int pageSize)

Add the incremental fetch information given the information passed as parameters

Parameters

out	MarkupOutput instance to update
pageNumber	number of page currently displayed
low	Lower limit on the display
up	Upper limit on the display
total	Total number of records to display
pageSize	Size of the page to display

public boolean renderLogFile (MarkupOutput out, DOMSupport domSupport, Document errorsXML)

Show the log file contents, according to the specified filters and sorting

Parameters

out	the MarkupOutput instance to modify with the HTML to be displayed
domSupport	`DOMSupport` instance for processing the Document instance to render
errorsXML	Document instance with the logging information to render to the user

Returns

True if the execution of the method ended in error (therefore the out parameter contains the error message, not the log display). False if no errors happened.

public void renderViewerError (MarkupOutput out, String message)

Display any error message found while processing the log files

Parameters

out	`MarkupOutput` instance
message	string with message to show to the user

public void renderViewerOptions (MarkupOutput out, WebEvent applyEvent, WebEvent loadDefaultsEvent, DiagnosticsBean bean)

Render the interface that shows the user the different options for viewing the log contents: type of logs and dates to cover.

Parameters

out	`MarkupOutput` instance where the HTML to render is to be saved
applyEvent	`WebEvent` used for submitting the form changes
loadDefaultsEvent	`WebEvent` used for loading the default values on the form
bean	`DiagnosticsBean` instance being transformed

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting the typical url information on the link (thus disabling any default onclick definition)

Parameters

event	WebEvent base information for the link

Returns

AnchorTag instance initialized

protected WebEvent getApplyDiagnosticsEvent (DiagnosticsBean bean)

Generate the event that will be used for applying or saving the diagnostics configuration specified on the form. Overwrites the original method for generating one that will make the log files from the selected date to be loaded.

Parameters

bean	`DiagnosticsBean` being transformed

Returns

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

protected WebEvent getSortEvent (DiagnosticsBean bean)

Get the event to use for sorting the contents of the diagnostics file.

Parameters

bean	`DiagnosticsBean` currently being transformed.

Returns

WebEvent initialized with the event, but without specifying which sorting will be executed if requested.

protected String getSortImage (int sort)

This method is deprecated.
This method is no longer used. Use CSS classes via getSortImageCss(int sort)

Get the image to render based on the current sort mode.

Parameters

sort	`int` value indicating the type of sorting. For example: `SORT_BY_LEVEL_DESCENDING`, `SORT_BY_TIMESTAMP_DESCENDING`, etc.

Returns

the corresponding sorting image to render

protected String getSortImageCss (int sort)

Get the image css to render based on the current sort mode.

Parameters

sort	`int` value indicating the type of sorting. For example: `SORT_BY_LEVEL_DESCENDING`, `SORT_BY_TIMESTAMP_DESCENDING`, etc.

Returns

the corresponding sorting image to render

protected String getTitle ()

Returns the title for the interface to display

Returns

the text to display as title of the transform

protected void setSortOrderEvent (WebEvent event, int sortOrder)

Sets the event to execute the indicated sort if requested.

Parameters

event	a not-null `WebEvent` instance, where to set the sort order requested
sortOrder	`int` indicating the sort order to request if the event is called. Valid values include `SORT_BY_TIMESTAMP_DESCENDING`, etc.