public class

DocumentExportTransform

extends DocumentSimpleTransform
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.AbstractDocumentTransform
             ↳ com.microstrategy.web.app.transforms.DocumentSimpleTransform
               ↳ com.microstrategy.web.app.transforms.DocumentExportTransform

Class Overview

DocumentExportTransform is the class that generates the output for a DocumentBean for exporting.
If the document is still executing it shows a wait image.
If its ready it transforms each ReportBean contained on the Document, using the style specified on the formal parameter styleExcel.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter exportFormat Determines the type of export format for the document.
public FormalParameter styleExcel The name of the style from the Style Catalog Editor to be used to export the document in excel.
public FormalParameter stylePageByInfo The name of the style from the Style Catalog Editor to be used to display the page by information for the document.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DocumentExportTransform()
Default no argument constructor.
Public Methods
String getDescription()
Return description for this Transform
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderPageByInfo(MarkupOutput mo, ReportBean rb)
Renders the page by information.
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
TransformInstance getPageByTransform(ReportBean rb)
TransformInstance getReportExcelTransform(ReportBean rb)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.DocumentSimpleTransform
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
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

public FormalParameter exportFormat

Determines the type of export format for the document.
This is the format to which the document would be exported to. Usually the value would be read from a preference named exportFormatDocuments.
Allowed Values:
The available export formats are specified in the pageConfig file under the node for the bean-type equal to DocumentBean. Usage:
You could set this value to excelWithoutFormatting or htmlDocuments

public FormalParameter styleExcel

The name of the style from the Style Catalog Editor to be used to export the document in excel.
Based on the style name we will use the corresponding transform to export the document in excel. The transform associated with the style must be able to tranform the document bean though.

public FormalParameter stylePageByInfo

The name of the style from the Style Catalog Editor to be used to display the page by information for the document.
Based on the style name we will use the corresponding transform to render the page by information. The transform associated with the style must be able to tranform the document bean though.

Public Constructors

public DocumentExportTransform ()

Default no argument constructor.

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • ' This Transform generates the output for a DocumentBean for exporting. If the Export format is "excelWithoutFormatting" then it assumes that the results are XML and transforms the result of each report XML with the XSL provided as formal parameter for other export formats it just returns the Document results'

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 renderPageByInfo (MarkupOutput mo, ReportBean rb)

Renders the page by information.

Parameters
mo Output by this transform
rb The ReportBean whose page by information we are going to render.

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 out)

Transform when the status is "Successful".

Parameters
out Output by this transform

Protected Methods

protected TransformInstance getPageByTransform (ReportBean rb)

protected TransformInstance getReportExcelTransform (ReportBean rb)