public abstract class

AbstractReportExportTransform

extends AbstractReportTransform
implements LayoutTransform
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
             ↳ com.microstrategy.web.app.transforms.AbstractReportExportTransform
Known Direct Subclasses

Class Overview

This definition is used as base for export transform classes such as ReportExportExcelFormatTransform and ReportExportHTMLFormatTransform. This hierarchy of classes takes care of handling an export request for a report and translating it into different calls to other transforms for rendering the different pieces of the final output, for example, page by information, filter details and ultimately, the actual grid.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected int colspan
protected FormalParameter renderOldStyleFilterDetails This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE
protected FormalParameter renderPageByAfterFilterDetails This formal parameter determines whether the page by information is rendered after the filter details section.
protected FormalParameter styleGraphs This formal parameter determines the style to be used to transform the report bean on graph mode.
protected FormalParameter styleGrids This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.
protected FormalParameter styleOutlineGrids This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.
protected FormalParameter stylePageByInfo This formal parameter determines the style to be used to transform the report bean to display the page by information.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractReportExportTransform()
Default empty constructor.
Public Methods
Map getAttributesBody()
Gets the list of html attributes for the body tag
Map getAttributesHTML()
Gets the list of html attributes for the html tag
Map getAttributesMainTable()
Gets the list of html attributes for the main table tag
String getDescription()
Return description for this Transform
void initializeProperties()
Initialize some properties for the transform.
void renderCss(MarkupOutput mo)
Render the necessary CSS files
void renderExcelHeader(MarkupOutput mo)
Renders the headers on top for reports
void renderFilterDetails(MarkupOutput mo)
Renders the report's filter details.
void renderFooter(MarkupOutput mo)
Reads the Export Footer from the Project Defaults> Export tab of the Preference page and puts at the bottom of the HTML page when a report is exported to HTML
void renderHeader(MarkupOutput mo)
Reads the Export Header from the Project Defaults> Export tab of the Preference page and puts at the top of the HTML page when a report is exported to HTML
void renderLinesBetweenGridAndGraph(MarkupOutput mo)
void renderMetaContentType(MarkupOutput out)
Renders the META tag with the content type
void renderNewLine(MarkupOutput mo)
Renders a new line (empty row)
void renderPageByInfo(MarkupOutput mo)
Renders the page by information
void renderReport(MarkupOutput mo)
Renders the report section
void renderReportName(MarkupOutput mo)
Renders the report name
void renderReportNameForTitle(MarkupOutput mo)
Renders the report name for the page's title
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
String applyLineBreak(String text)
ExportBean getExportBean()
Helper method for obtaining the ExportBean instance related with this transform
TransformInstance getPageByTransform(ReportBean rb)
Helper method for obtaining the Report Page By Transform associated with this instance
TransformInstance getReportGraphTransform(ViewBean vb)
Helper method for obtaining the Report Graph Transform associated with this instance
TransformInstance getReportGridTransform(ViewBean vb)
Helper method for obtaining the Report Grid Transform associated with this instance
TransformInstance getReportOutlineGridTransform(ViewBean vb)
Helper method for obtaining the Report Grid Outline Transform associated with this instance
void initFormalParasForGraphTransform(TransformInstance ti)
void initFormalParasForGridTransform(TransformInstance ti)
void initFormalParasForPageByTransform(TransformInstance ti)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected int colspan

protected FormalParameter renderOldStyleFilterDetails

This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE

protected FormalParameter renderPageByAfterFilterDetails

This formal parameter determines whether the page by information is rendered after the filter details section.
Allowed Values: TRUE/FALSE

protected FormalParameter styleGraphs

This formal parameter determines the style to be used to transform the report bean on graph mode.
Allowed Values: any report style name from StyleCatalog.xml file.

protected FormalParameter styleGrids

This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.
Allowed Values: any report style name from StyleCatalog.xml file.

protected FormalParameter styleOutlineGrids

This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.
Allowed Values: any report style name from StyleCatalog.xml file.

protected FormalParameter stylePageByInfo

This formal parameter determines the style to be used to transform the report bean to display the page by information.
Allowed Values: any report style name from StyleCatalog.xml file.

Public Constructors

public AbstractReportExportTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public Map getAttributesBody ()

Gets the list of html attributes for the body tag

public Map getAttributesHTML ()

Gets the list of html attributes for the html tag

public Map getAttributesMainTable ()

Gets the list of html attributes for the main table tag

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public void initializeProperties ()

Initialize some properties for the transform.
For example, it may overwrite some formal parameters' values depending on whether the corresponding feature is available.

public void renderCss (MarkupOutput mo)

Render the necessary CSS files

Parameters
mo MarkupOutput

public void renderExcelHeader (MarkupOutput mo)

Renders the headers on top for reports

Parameters
mo MarkupOutput

public void renderFilterDetails (MarkupOutput mo)

Renders the report's filter details.

Parameters
mo MarkupOutput

public void renderFooter (MarkupOutput mo)

Reads the Export Footer from the Project Defaults> Export tab of the Preference page and puts at the bottom of the HTML page when a report is exported to HTML

public void renderHeader (MarkupOutput mo)

Reads the Export Header from the Project Defaults> Export tab of the Preference page and puts at the top of the HTML page when a report is exported to HTML

public void renderLinesBetweenGridAndGraph (MarkupOutput mo)

public void renderMetaContentType (MarkupOutput out)

Renders the META tag with the content type

Parameters
out MarkupOutput

public void renderNewLine (MarkupOutput mo)

Renders a new line (empty row)

Parameters
mo the output object

public void renderPageByInfo (MarkupOutput mo)

Renders the page by information

Parameters
mo the output object

public void renderReport (MarkupOutput mo)

Renders the report section

Parameters
mo the output object

public void renderReportName (MarkupOutput mo)

Renders the report name

public void renderReportNameForTitle (MarkupOutput mo)

Renders the report name for the page's title

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo the output object

Protected Methods

protected String applyLineBreak (String text)

protected ExportBean getExportBean ()

Helper method for obtaining the ExportBean instance related with this transform

Returns
  • ExportBean instance linked to this transform class

protected TransformInstance getPageByTransform (ReportBean rb)

Helper method for obtaining the Report Page By Transform associated with this instance

Parameters
rb ReportBean instance being transformed

protected TransformInstance getReportGraphTransform (ViewBean vb)

Helper method for obtaining the Report Graph Transform associated with this instance

Parameters
vb ViewBean instance being transformed

protected TransformInstance getReportGridTransform (ViewBean vb)

Helper method for obtaining the Report Grid Transform associated with this instance

Parameters
vb ViewBean instance being transformed

protected TransformInstance getReportOutlineGridTransform (ViewBean vb)

Helper method for obtaining the Report Grid Outline Transform associated with this instance

Parameters
vb ViewBean instance being transformed

protected void initFormalParasForGraphTransform (TransformInstance ti)

protected void initFormalParasForGridTransform (TransformInstance ti)

protected void initFormalParasForPageByTransform (TransformInstance ti)