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

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

AbstractReportDataTransform, AbstractReportExportTransform, ReportDetailsTransform, ReportDetailsXHTMLTransform, ReportExportHTMLTransform, ReportExportPlainTextTransform, ReportGraphImageTransform, ReportIncrementalFetchTransform, ReportOptionsTransform, ReportPageByInfoTransform, ReportQuickLinksTransform, ReportSavePropertiesTransform, ReportToolbarTransform
```
public abstract class AbstractReportTransform
extends AbstractWebBeanTransform
```
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

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary
- Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
  AbstractAppTransform.Context

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.lang.String`	`BLANK_SUBSET_REPORT_ID`
`protected static java.lang.String`	`BLANK_XDA_REPORT_ID`
`protected FormalParameter`	`cssErrorMessage`	Deprecated. There are no references to this formal parameter in the application
`protected FormalParameter`	`cssErrorTitle`	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.

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors
Constructor Description

AbstractReportTransform()
default no-args constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canTransform(Transformable data)`	whether the data is transformable.
`protected AnchorTag`	`generateAnchor(WebEvent event)`	Overwrites the parent method by setting special attributes if the event is not provided
`void`	`generateErrorForIframe(MarkupOutput out, int errorCode, java.lang.String message)`	Method that generates the error contents when they have to be rendered to the user with an IFrame component.
`void`	`generateErrorForIframe(MarkupOutput out, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo, Tag extra)`	Method that generates the error contents when they have to be rendered to the user with an IFrame component.
`protected AnchorTag`	`generateIncFetchAnchor(WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)`	generate the anchor the the incremental fetch in report page.
`protected void`	`generateIncFetchOpenAnchor(MarkupOutput mo, WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)`	Deprecated. Please use `generateIncFetchAnchor(WebEvent event, boolean generateJSForDrillCheckBoxesForIncFetch)` instead
`protected WebEvent`	`getCancelEvent()`
`protected WebEvent`	`getContinueEvent()`	Returns a `WebEvent` instance corresponding to the continue event
`java.lang.String`	`getErrorMessage(int errorCode, java.lang.String defaultMessage)`	Returns the error message for the transform, based on the exception.
`java.lang.String`	`getErrorTitle(int errorCode)`	Returns the error title for the transform, overwrites by returning title specific about report execution.
`protected WebEvent`	`getHistoryListEvent()`	Returns a `WebEvent` instance corresponding to the go to history list event
`protected WebInboxSource`	`getInboxSource()`	return the `WebInboxSource` of this session.
`java.lang.String`	`getJobExpiredMessage()`	Returns the job expired message
`protected WebEvent`	`getNextColumnsEvent()`
`protected WebEvent`	`getPreviousColumnsEvent()`
`java.lang.String`	`getReexecuteButtonDescription()`	Returns the description of the reexecute button
`protected ReportBean`	`getReportBean()`	return the current report bean.
`java.lang.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.
`protected WebEvent`	`getRepromptEvent()`	Returns a `WebEvent` instance corresponding to the reprompt event
`java.lang.Class`	`getSupportedBeanType()`	return the bean type supported by this transform.
`protected WebEvent`	`getViewDetailsEvent()`
`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`
`protected boolean`	`isDesignMode()`	This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
`protected boolean`	`isIFrameEnabled()`	whether iframe feature is enabled.
`boolean`	`isIncRefreshReport()`
`boolean`	`isNonViewableReport()`
`protected void`	`renderColumnsIncrementalFetch(MarkupOutput out, WebEvent event, java.lang.String imgCss)`
`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.
`protected void`	`renderContinueFormForRequestInError(Tag container, int errorCode)`	Render the continue form when the status is `In Error`
`void`	`renderErrorButtons(MarkupOutput out, int errorCode, java.lang.String message)`	Deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
`void`	`renderErrorInfo(MarkupOutput out, int errorCode, java.lang.String message)`	Deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
`protected void`	`renderHistoryListButton(MarkupOutput out)`	Renders the History List button for the wait page.
`void`	`renderImage(MarkupOutput out, java.lang.String image)`	Renders a transform's image.
`void`	`renderJobExpiredSection(MarkupOutput out, java.lang.String title, Tag form)`	Renders the job expired section, including an error message and an reexecute button
`void`	`renderProcessingButtons(MarkupOutput out)`	Render the buttons when in processing status.
`void`	`renderProcessingInfo(MarkupOutput out)`	Transform when the status is "In Processing".
`protected void`	`renderProcessingInfoDetails(MarkupOutput out)`	Called by `renderProcessingInfo(com.microstrategy.web.beans.MarkupOutput)`, it renders the detailed information about the report that is being processed, including name, status and description.
`protected void`	`renderViewDetailsButton(MarkupOutput out)`	Renders the View Details button for the wait page.
`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 boolean`	`useBuiltInFormat()`	Check whether the formal parameter "useBuiltInFormatPara" is true or false.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestSuccessful, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.Transform
getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

- Field Detail
  - cssUseFileContent
```
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.
  - useBuiltInFormatPara
```
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.
  - iFramePara
```
protected FormalParameter iFramePara
```
    This is the flag used to indicate wheter the transform will use iframes.
    Allowed Values: TRUE/FALSE.
  - imgError
```
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.
  - cssErrorTitle
```
protected FormalParameter cssErrorTitle
```
    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.
  - cssErrorMessage
```
protected FormalParameter cssErrorMessage
```
    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.
  - showScroller
```
protected FormalParameter showScroller
```
    Indicates if the transform will render navigation scrollers along with the graph image.
    Allowed Values: TRUE/FALSE
    
    Since:
    
    MicroStrategy Web 9.0.0
  - generateJSForDrillCheckBoxesForIncFetch
```
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.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - BLANK_XDA_REPORT_ID
```
protected static final java.lang.String BLANK_XDA_REPORT_ID
```
    See Also:
    
    Constant Field Values
  - BLANK_SUBSET_REPORT_ID
```
protected static final java.lang.String BLANK_SUBSET_REPORT_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractReportTransform
```
public AbstractReportTransform()
```
    default no-args constructor.
- Method Detail
  - initializeImages
```
public void initializeImages()
```
    initialize the images for the transform.
    
    Overrides:
    
    initializeImages in class AbstractAppTransform
  - initializeTransform
```
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
    
    Specified by:
    
    initializeTransform in interface AppTransform
    
    Overrides:
    
    initializeTransform in class AbstractAppTransform
    
    Parameters:
    
    data - the bean to transform.
  - initializeWebComponent
```
public void initializeWebComponent(Transformable data)
```
    Initialize the web component to be used by the transform.
    
    Specified by:
    
    initializeWebComponent in interface AppTransform
    
    Overrides:
    
    initializeWebComponent in class AbstractAppTransform
    
    Parameters:
    
    data - the bean to transform.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - transformForRequestNotInited
```
public void transformForRequestNotInited(MarkupOutput out)
```
    Transform when the status is Not initialized.
    
    Overrides:
    
    transformForRequestNotInited in class AbstractAppTransform
    
    Parameters:
    
    out - output by this transform
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - transformForRequestInError
```
public void transformForRequestInError(MarkupOutput out)
```
    Transform when the status is In Error.
    
    Overrides:
    
    transformForRequestInError in class AbstractAppTransform
    
    Parameters:
    
    out - output by this transform
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - renderContinueFormForRequestInError
```
protected void renderContinueFormForRequestInError(Tag container,
                                                   int errorCode)
```
    Render the continue form when the status is In Error
  - generateErrorForIframe
```
public void generateErrorForIframe(MarkupOutput out,
                                   int errorCode,
                                   java.lang.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
  - generateErrorForIframe
```
public void generateErrorForIframe(MarkupOutput out,
                                   java.lang.String title,
                                   java.lang.String message,
                                   java.lang.String errorInfo,
                                   java.lang.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)
    
    Overrides:
    
    generateErrorForIframe in class AbstractWebBeanTransform
    
    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.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderErrorInfo
```
public void renderErrorInfo(MarkupOutput out,
                            int errorCode,
                            java.lang.String message)
```
    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
  - renderErrorButtons
```
public void renderErrorButtons(MarkupOutput out,
                               int errorCode,
                               java.lang.String message)
```
    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
  - generateAnchor
```
protected AnchorTag generateAnchor(WebEvent event)
```
    Overwrites the parent method by setting special attributes if the event is not provided
    
    Overrides:
    
    generateAnchor in class AbstractAppTransform
    
    Parameters:
    
    event - WebEvent
    
    Returns:
    
    AnchorTag
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setWebReexecuteEventArguments
```
public void setWebReexecuteEventArguments(WebEvent __result)
                                   throws WebBeanException
```
    Sets the reexecute web event's arguments
    
    Overrides:
    
    setWebReexecuteEventArguments in class AbstractWebBeanTransform
    
    Parameters:
    
    __result - WebEvent instance to update
    
    Throws:
    
    WebBeanException
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getWebReexecuteEvent
```
public WebEvent getWebReexecuteEvent()
```
    Returns a WebEvent instance corresponding to the reexecute event
    
    Overrides:
    
    getWebReexecuteEvent in class AbstractWebBeanTransform
    
    Returns:
    
    the web reexecute event
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getJobExpiredMessage
```
public java.lang.String getJobExpiredMessage()
```
    Returns the job expired message
    
    Overrides:
    
    getJobExpiredMessage in class AbstractWebBeanTransform
    
    Returns:
    
    the job expired message.
    
    Since:
    
    MicroStrategy Web 8.0.1
  - renderJobExpiredSection
```
public void renderJobExpiredSection(MarkupOutput out,
                                    java.lang.String title,
                                    Tag form)
```
    Renders the job expired section, including an error message and an reexecute button
    
    Overrides:
    
    renderJobExpiredSection in class AbstractWebBeanTransform
    
    Parameters:
    
    out -
    
    title -
    
    form -
  - getContinueEvent
```
protected WebEvent getContinueEvent()
```
    Returns a WebEvent instance corresponding to the continue event
    
    Returns:
    
    a WebEvent instance to continue browsing if an error happened.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getRepromptEvent
```
protected WebEvent getRepromptEvent()
```
    Returns a WebEvent instance corresponding to the reprompt event
    
    Returns:
    
    a WebEvent instance to reprompt the report if an error happened.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getErrorTitle
```
public java.lang.String getErrorTitle(int errorCode)
```
    Returns the error title for the transform, overwrites by returning title specific about report execution.
    
    Overrides:
    
    getErrorTitle in class AbstractAppTransform
    
    Parameters:
    
    errorCode - the error's id
    
    Returns:
    
    The title for the error message.
  - getErrorMessage
```
public java.lang.String getErrorMessage(int errorCode,
                                        java.lang.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".
    
    Overrides:
    
    getErrorMessage in class AbstractAppTransform
    
    Parameters:
    
    errorCode - the error's id
    
    defaultMessage - the error's default message
    
    Returns:
    
    The error message to render to the user
  - renderProcessingInfo
```
public void renderProcessingInfo(MarkupOutput out)
```
    Transform when the status is "In Processing".
    
    Overrides:
    
    renderProcessingInfo in class AbstractAppTransform
    
    Parameters:
    
    out - MarkupOutput instance where to save the output of this method
    
    See Also:
    
    AbstractAppTransform.transformForRequestProcessing(com.microstrategy.web.beans.MarkupOutput)
  - renderProcessingInfoDetails
```
protected void renderProcessingInfoDetails(MarkupOutput out)
```
    Called by renderProcessingInfo(com.microstrategy.web.beans.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.
    
    Since:
    
    MicroStrategy Web 8.0.2
  - renderProcessingButtons
```
public void renderProcessingButtons(MarkupOutput out)
```
    Render the buttons when in processing status.
    
    Overrides:
    
    renderProcessingButtons in class AbstractAppTransform
    
    Parameters:
    
    out - MarkupOutput instance where to save the output of this method
    
    See Also:
    
    AbstractAppTransform.transformForRequestProcessing(com.microstrategy.web.beans.MarkupOutput)
  - getCancelEvent
```
protected WebEvent getCancelEvent()
```
    Overrides:
    
    getCancelEvent in class AbstractAppTransform
    
    Returns:
    
    WebEvent instance initialized with the information for cancelling a request
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderHistoryListButton
```
protected void renderHistoryListButton(MarkupOutput out)
                                throws java.lang.IllegalStateException,
                                       java.lang.IllegalArgumentException,
                                       UnmodifiableException
```
    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
    - AbstractAppTransform.processingButtonsFlags does not have AbstractAppTransform.PROCESSING_BUTTONS_HISTORY_LIST
    
    Parameters:
    
    out - output for this transform
    
    Throws:
    
    java.lang.IllegalStateException
    
    java.lang.IllegalArgumentException
    
    UnmodifiableException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getHistoryListEvent
```
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)
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderViewDetailsButton
```
protected void renderViewDetailsButton(MarkupOutput out)
                                throws java.lang.IllegalStateException,
                                       java.lang.IllegalArgumentException,
                                       UnmodifiableException
```
    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
    - AbstractAppTransform.processingButtonsFlags does not have AbstractAppTransform.PROCESSING_BUTTONS_VIEW_DETAILS
    
    Parameters:
    
    out - output for this transform
    
    Throws:
    
    java.lang.IllegalStateException
    
    java.lang.IllegalArgumentException
    
    UnmodifiableException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getViewDetailsEvent
```
protected WebEvent getViewDetailsEvent()
```
    Returns:
    
    WebEvent instance initialized with the information for viewing the details of the report.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getReportStatus
```
public java.lang.String getReportStatus(int status)
```
    get the report's status as a string representation.
    
    Parameters:
    
    status - the status as an integer
    
    Returns:
    
    the status string
  - getReportStatusDescriptorKey
```
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
  - generateIncFetchAnchor
```
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.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - generateIncFetchOpenAnchor
```
protected void generateIncFetchOpenAnchor(MarkupOutput mo,
                                          WebEvent event,
                                          boolean generateJSForDrillCheckBoxesForIncFetch)
```
    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
  - getReportBean
```
protected ReportBean getReportBean()
```
    return the current report bean.
    
    Returns:
    
    the current report bean
  - getInboxSource
```
protected WebInboxSource getInboxSource()
```
    return the WebInboxSource of this session.
    
    Returns:
    
    the WebInboxSource of this session.
  - initializeProperties
```
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).
  - isIFrameEnabled
```
protected boolean isIFrameEnabled()
```
    whether iframe feature is enabled.
    
    Overrides:
    
    isIFrameEnabled in class AbstractAppTransform
    
    Returns:
    
    whether iframe feature is enabled
  - renderImage
```
public void renderImage(MarkupOutput out,
                        java.lang.String image)
```
    Renders a transform's image. Extends by including images of this transform.
    
    Overrides:
    
    renderImage in class AbstractAppTransform
    
    Parameters:
    
    out - where to write the output of the method.
    
    image - the image name
  - getSupportedBeanType
```
public java.lang.Class getSupportedBeanType()
```
    return the bean type supported by this transform.
    
    Specified by:
    
    getSupportedBeanType in interface Transform
    
    Overrides:
    
    getSupportedBeanType in class AbstractAppTransform
    
    Returns:
    
    the bean type
  - canTransform
```
public boolean canTransform(Transformable data)
```
    whether the data is transformable.
    
    Specified by:
    
    canTransform in interface Transform
    
    Overrides:
    
    canTransform in class AbstractTransform
    
    Parameters:
    
    data - the data
    
    Returns:
    
    whether the data is transformable
  - useBuiltInFormat
```
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
  - getReexecuteButtonDescription
```
public java.lang.String getReexecuteButtonDescription()
```
    Returns the description of the reexecute button
    
    Overrides:
    
    getReexecuteButtonDescription in class AbstractWebBeanTransform
    
    Returns:
    
    the description of the reexecute button
    
    Since:
    
    MicroStrategy Web 8.0.1
  - isDesignMode
```
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.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - renderColumnsIncrementalFetchPrevious
```
public void renderColumnsIncrementalFetchPrevious(MarkupOutput out)
```
    Generates the arrow for the previous set of columns.
    
    Parameters:
    
    out - MarkupOutput to generate the HTML.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - renderColumnsIncrementalFetchNext
```
public void renderColumnsIncrementalFetchNext(MarkupOutput out)
```
    Generates the arrow for the next set of columns.
    
    Parameters:
    
    out - MarkupOutput to generate the HTML.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - renderColumnsIncrementalFetch
```
protected void renderColumnsIncrementalFetch(MarkupOutput out,
                                             WebEvent event,
                                             java.lang.String imgCss)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getNextColumnsEvent
```
protected WebEvent getNextColumnsEvent()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getPreviousColumnsEvent
```
protected WebEvent getPreviousColumnsEvent()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - isNonViewableReport
```
public boolean isNonViewableReport()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - isDatamart
```
public boolean isDatamart()
```
    Returns true if the report's objectSubType is EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart
    
    Since:
    
    MicroStrategy Web 9.0.0
  - isCubeReport
```
public boolean isCubeReport()
```
    Returns true if the report's objectSubType is EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
    
    Since:
    
    MicroStrategy Web 9.0.0
  - isIncRefreshReport
```
public boolean isIncRefreshReport()
```

Class AbstractReportTransform

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.web.transform.Transform

Field Detail

cssUseFileContent

useBuiltInFormatPara

iFramePara

imgError

cssErrorTitle

cssErrorMessage

showScroller

generateJSForDrillCheckBoxesForIncFetch

BLANK_XDA_REPORT_ID

BLANK_SUBSET_REPORT_ID

Constructor Detail

AbstractReportTransform

Method Detail

initializeImages

initializeTransform

initializeWebComponent

transformForRequestNotInited

transformForRequestInError

renderContinueFormForRequestInError

generateErrorForIframe

generateErrorForIframe

renderErrorInfo

renderErrorButtons

generateAnchor

setWebReexecuteEventArguments

getWebReexecuteEvent

getJobExpiredMessage

renderJobExpiredSection

getContinueEvent

getRepromptEvent

getErrorTitle

getErrorMessage

renderProcessingInfo

renderProcessingInfoDetails

renderProcessingButtons

getCancelEvent

renderHistoryListButton

getHistoryListEvent

renderViewDetailsButton

getViewDetailsEvent

getReportStatus

getReportStatusDescriptorKey

generateIncFetchAnchor

generateIncFetchOpenAnchor

getReportBean

getInboxSource

initializeProperties

isIFrameEnabled

renderImage

getSupportedBeanType

canTransform

useBuiltInFormat

getReexecuteButtonDescription

isDesignMode

renderColumnsIncrementalFetchPrevious

renderColumnsIncrementalFetchNext

renderColumnsIncrementalFetch

getNextColumnsEvent

getPreviousColumnsEvent

isNonViewableReport

isDatamart

isCubeReport

isIncRefreshReport