public abstract class

AbstractReportTransform

extends AbstractWebBeanTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractReportTransform is an abstract class extending from AbstractAppTranform.
All functional report transform classes, such as ReportTransformGrid, ReportTransformGraph, ... are extending from it.
Copyright: Copyright (c) 2001

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter cssErrorMessage This field is deprecated. There are no references to this formal parameter in the application
protected FormalParameter cssErrorTitle This field is deprecated. There are no references to this formal parameter anymore
protected FormalParameter cssUseFileContent This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
protected FormalParameter generateJSForDrillCheckBoxesForIncFetch This is the flag which will decide if we need to generate the javascript code required to preserve check boxes for drilling in incremental fetch.
protected FormalParameter iFramePara This is the flag used to indicate wheter the transform will use iframes.
protected FormalParameter imgError This is the Image to display when there bean is in Error status.
protected FormalParameter showScroller Indicates if the transform will render navigation scrollers along with the graph image.
protected FormalParameter useBuiltInFormatPara This is the flag used in the transform to specify whether to use the formatting info from the report definition.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractReportTransform()
default no-args constructor.
Public Methods
boolean canTransform(Transformable data)
whether the data is transformable.
void generateErrorForIframe(MarkupOutput out, String title, String message, String errorInfo, String contactInfo, Tag extra)
Method that generates the error contents when they have to be rendered to the user with an IFrame component.
void generateErrorForIframe(MarkupOutput out, int errorCode, String message)
Method that generates the error contents when they have to be rendered to the user with an IFrame component.
String getErrorMessage(int errorCode, String defaultMessage)
Returns the error message for the transform, based on the exception.
String getErrorTitle(int errorCode)
Returns the error title for the transform, overwrites by returning title specific about report execution.
String getJobExpiredMessage()
Returns the job expired message
String getReexecuteButtonDescription()
Returns the description of the reexecute button
String getReportStatus(int status)
get the report's status as a string representation.
static int getReportStatusDescriptorKey(int status)
get the descriptor key for the report status.
Class getSupportedBeanType()
return the bean type supported by this transform.
WebEvent getWebReexecuteEvent()
Returns a WebEvent instance corresponding to the reexecute event
void initializeImages()
initialize the images for the transform.
void initializeProperties()
Initialize the Transform's properties based on Formal Parameters, Bean status, features, etc..
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.
boolean isCubeReport()
Returns true if the report's objectSubType is EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
boolean isDatamart()
Returns true if the report's objectSubType is EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart
boolean isIncRefreshReport()
boolean isNonViewableReport()
void renderColumnsIncrementalFetchNext(MarkupOutput out)
Generates the arrow for the next set of columns.
void renderColumnsIncrementalFetchPrevious(MarkupOutput out)
Generates the arrow for the previous set of columns.
void renderErrorButtons(MarkupOutput out, int errorCode, String message)
This method is deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
void renderErrorInfo(MarkupOutput out, int errorCode, String message)
This method is deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
void renderImage(MarkupOutput out, String image)
Renders a transform's image.
void renderProcessingButtons(MarkupOutput out)
Render the buttons when in processing status.
void renderProcessingInfo(MarkupOutput out)
Transform when the status is "In Processing".
void setWebReexecuteEventArguments(WebEvent __result)
Sets the reexecute web event's arguments
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
void transformForRequestNotInited(MarkupOutput out)
Transform when the status is Not initialized.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
AnchorTag generateIncFetchAnchor(WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)
generate the anchor the the incremental fetch in report page.
void generateIncFetchOpenAnchor(MarkupOutput mo, WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)
This method is deprecated. Please use generateIncFetchAnchor(WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch) instead
WebEvent getCancelEvent()
WebEvent getContinueEvent()
Returns a WebEvent instance corresponding to the continue event
WebEvent getHistoryListEvent()
Returns a WebEvent instance corresponding to the go to history list event
WebInboxSource getInboxSource()
return the WebInboxSource of this session.
WebEvent getNextColumnsEvent()
WebEvent getPreviousColumnsEvent()
ReportBean getReportBean()
return the current report bean.
WebEvent getRepromptEvent()
Returns a WebEvent instance corresponding to the reprompt event
WebEvent getViewDetailsEvent()
boolean isDesignMode()
This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
boolean isIFrameEnabled()
whether iframe feature is enabled.
void renderColumnsIncrementalFetch(MarkupOutput out, WebEvent event, String imgCss)
void renderHistoryListButton(MarkupOutput out)
Renders the History List button for the wait page.
void renderProcessingInfoDetails(MarkupOutput out)
Called by renderProcessingInfo(MarkupOutput), it renders the detailed information about the report that is being processed, including name, status and description.
void renderViewDetailsButton(MarkupOutput out)
Renders the View Details button for the wait page.
boolean useBuiltInFormat()
Check whether the formal parameter "useBuiltInFormatPara" is true or false.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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 FormalParameter cssErrorMessage

This field is deprecated.
There are no references to this formal parameter in the application

This is the css name for the error message.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter cssErrorTitle

This field is deprecated.
There are no references to this formal parameter anymore

This is the css name for the error title.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter cssUseFileContent

This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
Allowed Values: TRUE/FALSE.

protected FormalParameter generateJSForDrillCheckBoxesForIncFetch

This is the flag which will decide if we need to generate the javascript code required to preserve check boxes for drilling in incremental fetch.
Allowed Values: TRUE/FALSE.

protected FormalParameter iFramePara

This is the flag used to indicate wheter the transform will use iframes.
Allowed Values: TRUE/FALSE.

protected FormalParameter imgError

This is the Image to display when there bean is in Error status.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter showScroller

Indicates if the transform will render navigation scrollers along with the graph image.
Allowed Values: TRUE/FALSE

protected FormalParameter useBuiltInFormatPara

This is the flag used in the transform to specify whether to use the formatting info from the report definition.
Out of box, we map the first preference in Grid preferences section to this formal parameter.
If it's TRUE, WebCSSHelper.getCSS() will give the css class definitions, which is from report formatting defintion.
If it's FALSE, a specified css file will give the css class definitions, which is what formal paramter cssFile means.
Allowed Values: TRUE/FALSE.

Public Constructors

public AbstractReportTransform ()

default no-args constructor.

Public Methods

public boolean canTransform (Transformable data)

whether the data is transformable.

Parameters
data the data
Returns
  • whether the data is transformable

public void generateErrorForIframe (MarkupOutput out, String title, String message, String errorInfo, String contactInfo, Tag extra)

Method that generates the error contents when they have to be rendered to the user with an IFrame component. (This will render a hidden DIV for the IFRAME)

Parameters
out MarkupOutput instance where to save the HTML output of this method
title String with the title of the error message
message String with the content of the message
errorInfo String with details of the error
contactInfo String with the contact information
extra Tag instance with any other extra content to render to the user as part of the message.

public void generateErrorForIframe (MarkupOutput out, int errorCode, String message)

Method that generates the error contents when they have to be rendered to the user with an IFrame component. (This will render a hidden DIV for the IFRAME)

Parameters
out MarkupOutput instance where to save the HTML output of this method
errorCode identifier of the error to be rendered
message String with the message to display by default

public String getErrorMessage (int errorCode, String defaultMessage)

Returns the error message for the transform, based on the exception.
Overwrites by returning either the original message, or if none was provided, an "Error in report results".

Parameters
errorCode the error's id
defaultMessage the error's default message
Returns
  • The error message to render to the user

public String getErrorTitle (int errorCode)

Returns the error title for the transform, overwrites by returning title specific about report execution.

Parameters
errorCode the error's id
Returns
  • The title for the error message.

public String getJobExpiredMessage ()

Returns the job expired message

Returns
  • the job expired message.

public String getReexecuteButtonDescription ()

Returns the description of the reexecute button

Returns
  • the description of the reexecute button

public String getReportStatus (int status)

get the report's status as a string representation.

Parameters
status the status as an integer
Returns
  • the status string

public static int getReportStatusDescriptorKey (int status)

get the descriptor key for the report status.

Parameters
status the status as an integer
Returns
  • the descriptor key as in integer

public Class getSupportedBeanType ()

return the bean type supported by this transform.

Returns
  • the bean type

public WebEvent getWebReexecuteEvent ()

Returns a WebEvent instance corresponding to the reexecute event

Returns
  • the web reexecute event

public void initializeImages ()

initialize the images for the transform.

public void initializeProperties ()

Initialize the Transform's properties based on Formal Parameters, Bean status, features, etc..
This method is only invoked when the Bean is ready to display (i.e., it's XMLStatus is succesfull).

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. After calling the initializeTransform on super, it calls initializeProperties if the XMLStatus of the reportBean is WebBeanRequestSuccessful

Parameters
data the bean to transform.

public void initializeWebComponent (Transformable data)

Initialize the web component to be used by the transform.

Parameters
data the bean to transform.

public boolean isCubeReport ()

Returns true if the report's objectSubType is EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube

public boolean isDatamart ()

Returns true if the report's objectSubType is EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart

public boolean isIncRefreshReport ()

public boolean isNonViewableReport ()

public void renderColumnsIncrementalFetchNext (MarkupOutput out)

Generates the arrow for the next set of columns.

Parameters
out MarkupOutput to generate the HTML.

public void renderColumnsIncrementalFetchPrevious (MarkupOutput out)

Generates the arrow for the previous set of columns.

Parameters
out MarkupOutput to generate the HTML.

public void renderErrorButtons (MarkupOutput out, int errorCode, String message)

This method is deprecated.
This method is no longer used by the Transform, all the logic is now in the transformForRequestInError

Renders a "continue" or "re-execute" buttons for the user to continue working.

Parameters
out the transform's output
errorCode the error's id
message the error's message

public void renderErrorInfo (MarkupOutput out, int errorCode, String message)

This method is deprecated.
This method is no longer used by the Transform, all the logic is now in the transformForRequestInError

Render the message to display to the user in case there is an error.

Parameters
out the transform's output
errorCode the error's id
message the error's message

public void renderImage (MarkupOutput out, String image)

Renders a transform's image. Extends by including images of this transform.

Parameters
out where to write the output of the method.
image the image name

public void renderProcessingButtons (MarkupOutput out)

Render the buttons when in processing status.

Parameters
out MarkupOutput instance where to save the output of this method

public void renderProcessingInfo (MarkupOutput out)

Transform when the status is "In Processing".

Parameters
out MarkupOutput instance where to save the output of this method

public void setWebReexecuteEventArguments (WebEvent __result)

Sets the reexecute web event's arguments

Parameters
__result WebEvent instance to update
Throws
WebBeanException
WebBeanException

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error.

Parameters
out output by this transform

public void transformForRequestNotInited (MarkupOutput out)

Transform when the status is Not initialized.

Parameters
out output by this transform

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent
Returns
  • AnchorTag

protected AnchorTag generateIncFetchAnchor (WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)

generate the anchor the the incremental fetch in report page.

Parameters
event the WebEvent object
generateJSForDrillCheckBoxesForIncFetch whether the javascript code is generated
Returns
  • an AnchorTag instance initialized with the information for requesting an incremental fetch manipulation.

protected void generateIncFetchOpenAnchor (MarkupOutput mo, WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)

This method is deprecated.
Please use generateIncFetchAnchor(WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch) instead

generate the open anchor the the incremental fetch in report page.

Parameters
mo the MarkupOutput object
event the WebEvent object
generateJSForDrillCheckBoxesForIncFetch whether the javascript code is generated

protected WebEvent getCancelEvent ()

Returns
  • WebEvent instance initialized with the information for cancelling a request

protected WebEvent getContinueEvent ()

Returns a WebEvent instance corresponding to the continue event

Returns
  • a WebEvent instance to continue browsing if an error happened.

protected WebEvent getHistoryListEvent ()

Returns a WebEvent instance corresponding to the go to history list event

Returns
  • WebEvent instance initialized with the information for going to the History List (Inbox)

protected WebInboxSource getInboxSource ()

return the WebInboxSource of this session.

Returns
  • the WebInboxSource of this session.

protected WebEvent getNextColumnsEvent ()

protected WebEvent getPreviousColumnsEvent ()

protected ReportBean getReportBean ()

return the current report bean.

Returns
  • the current report bean

protected WebEvent getRepromptEvent ()

Returns a WebEvent instance corresponding to the reprompt event

Returns
  • a WebEvent instance to reprompt the report if an error happened.

protected WebEvent getViewDetailsEvent ()

Returns
  • WebEvent instance initialized with the information for viewing the details of the report.

protected boolean isDesignMode ()

This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.

Returns
  • false by default. Any inherting class should override to implement its own version.

protected boolean isIFrameEnabled ()

whether iframe feature is enabled.

Returns
  • whether iframe feature is enabled

protected void renderColumnsIncrementalFetch (MarkupOutput out, WebEvent event, String imgCss)

protected void renderHistoryListButton (MarkupOutput out)

Renders the History List button for the wait page.
It calls getHistoryListEvent() to obtain the event used for the button
The button is not rendered if:
- getHistoryListEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_HISTORY_LIST

Parameters
out output for this transform
Throws
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderProcessingInfoDetails (MarkupOutput out)

Called by renderProcessingInfo(MarkupOutput), it renders the detailed information about the report that is being processed, including name, status and description.

Parameters
out MarkupOutput instance where the HTML contents will be saved.

protected void renderViewDetailsButton (MarkupOutput out)

Renders the View Details button for the wait page.
It calls getViewDetailsEvent() to obtain the event used for the button
The button is not rendered if:
- getViewDetailsEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_VIEW_DETAILS

Parameters
out output for this transform
Throws
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected boolean useBuiltInFormat ()

Check whether the formal parameter "useBuiltInFormatPara" is true or false.
If it's true, the transform uses built-in format of the report;
If it's false, the transform uses some css file specified in another formal parameter "cssFile".

Returns
  • the boolean value of the formal parameter