public class

ReportExportPlainTextTransform

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.ReportExportPlainTextTransform

Class Overview

ReportTransformExportPlain is the class that generates the output for a ReportBean in plaintext format for exporting to a text file Used for exporting to plaintext, CSV and Excel with plaintext.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter _isCSV This field is deprecated. we now read this value from the export format type of the export format property of the ExportBean
protected FormalParameter _isExcel This field is deprecated. We now read this value from getExportFormat() and then ask for isExcel()
protected FormalParameter _renderOldStyleFilterDetails This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE
protected FormalParameter _styleName This field is deprecated. We do not use a transform to render the report bean, we use getExportData()
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
ReportExportPlainTextTransform()
Default empty constructor.
Public Methods
String getDescription()
Return description for this Transform
void initializeProperties()
Initialize some properties for the transform.
void renderFilterDetails(MarkupOutput mo)
Renders the filter details
void renderFooter(MarkupOutput mo)
Renders a footer section that is added at the end of the exported results.
void renderHeader(MarkupOutput mo)
Renders a header section that is added at the top of the exported results.
void renderNewLine(MarkupOutput mo)
Renders A new line (carriage return)
void renderPageByInfo(MarkupOutput mo, ReportBean rb)
Renders the Page-by information displayed after the report name when reports have elements on the page-by axis.
void renderPageByInfo(MarkupOutput mo)
Renders the Page-by information displayed after the report name when reports have elements on the page-by axis.
void renderReport(MarkupOutput mo)
Renders the report
void renderReportName(MarkupOutput mo, String reportName)
Renders the report name displayed at the top of the page.
void renderReportName(MarkupOutput mo)
Renders the report name displayed at the top of the page.
void renderReportName(String reportName, MarkupOutput mo)
This method is deprecated. Use renderReportName(MarkupOutput, String)
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
String cleanTextForExport(String text)
This methods cleans a string to be displayed in Excel.
TransformInstance getPageByTransform(ReportBean rb)
[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 FormalParameter _isCSV

This field is deprecated.
we now read this value from the export format type of the export format property of the ExportBean

This formal parameter determines whether the pplication should export in a CSV format.
Allowed Values: TRUE/FALSE.

protected FormalParameter _isExcel

This field is deprecated.
We now read this value from getExportFormat() and then ask for isExcel()

This formal parameter determines whether the application to Export to is Excel.
Allowed Values: TRUE/FALSE.

protected FormalParameter _renderOldStyleFilterDetails

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

protected FormalParameter _styleName

This field is deprecated.
We do not use a transform to render the report bean, we use getExportData()

This formal parameter determines the style name to be used to transform the report bean.
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 ReportExportPlainTextTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

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 renderFilterDetails (MarkupOutput mo)

Renders the filter details

Parameters
mo MarkupOutput the output object

public void renderFooter (MarkupOutput mo)

Renders a footer section that is added at the end of the exported results.
The value of the header is saved as a project property and can be modified under "Preferences > Project Defaults > Project Footer"

Parameters
mo MarkupOutput

public void renderHeader (MarkupOutput mo)

Renders a header section that is added at the top of the exported results.
The value of the header is saved as a project property and can be modified under "Preferences > Project Defaults > Project Header"

Parameters
mo MarkupOutput

public void renderNewLine (MarkupOutput mo)

Renders A new line (carriage return)

Parameters
mo MarkupOutput the output object

public void renderPageByInfo (MarkupOutput mo, ReportBean rb)

Renders the Page-by information displayed after the report name when reports have elements on the page-by axis.

Parameters
mo the output object
rb Report bean to export

public void renderPageByInfo (MarkupOutput mo)

Renders the Page-by information displayed after the report name when reports have elements on the page-by axis.

Parameters
mo the output object

public void renderReport (MarkupOutput mo)

Renders the report

Parameters
mo MarkupOutput the output object

public void renderReportName (MarkupOutput mo, String reportName)

Renders the report name displayed at the top of the page.

Parameters
mo the output object
reportName name of the report

public void renderReportName (MarkupOutput mo)

Renders the report name displayed at the top of the page.

Parameters
mo the output object

public void renderReportName (String reportName, MarkupOutput mo)

This method is deprecated.
Use renderReportName(MarkupOutput, String)

Renders the report name displayed at the top of the page.

Parameters
reportName name of the report
mo the output object

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 cleanTextForExport (String text)

This methods cleans a string to be displayed in Excel.
Adds a space if the text starts with "=", "+" and "-"

Parameters
text text to clean
Returns
  • cleaned text

protected TransformInstance getPageByTransform (ReportBean rb)