public class

ReportExportIServerTransform

extends AbstractExportTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractExportTransform
           ↳ com.microstrategy.web.app.transforms.ReportExportIServerTransform

Class Overview

This is the Transform that exports a Report Bean to Excel with formatting, Excel with Plaintext, CSV or plaintext.
The export format must be set on the ExportBean. The export output is obtained form the Intelligence Server.
This transform assumes that the Execution mode on the Report Bean has been set to REPORT_MODE_EXCEL for Excel with formatting or REPORT_MODE_CSV for Excel with Plaintext, CSV or plaintext.

Summary

Constants
String ENCODING_CHARSET_SEPARATOR
String ENCODING_CLASS_SEPARATOR
String ENCODING_MAP_SEPARATOR
String FP_EXPORT_FORMAT Constant for the name of the exportFormat Formal Parameter.
String FP_SPECIAL_ENCODING Constant for the name of the specialEncoding Formal Parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter exportFormat Indicates the export format name
public FormalParameter specialEncoding Indicates the list of special encoding to be used.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractExportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportExportIServerTransform()
Public Methods
String getDescription()
Return description for this Transform
Class getSupportedBeanType()
return the bean type supported by this transform.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderShell(MarkupOutput out)
Overwrites the default implementation to prevent a shell from being rendered.
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
ExportBeanHelper getExportBeanHelper()
Returns the export bean helper used to setup the export headers.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractExportTransform
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

Constants

public static final String ENCODING_CHARSET_SEPARATOR

Constant Value: ","

public static final String ENCODING_CLASS_SEPARATOR

Constant Value: ":"

public static final String ENCODING_MAP_SEPARATOR

Constant Value: ";"

public static final String FP_EXPORT_FORMAT

Constant for the name of the exportFormat Formal Parameter.

See Also
Constant Value: "exportFormat"

public static final String FP_SPECIAL_ENCODING

Constant for the name of the specialEncoding Formal Parameter.

See Also
Constant Value: "specialEncoding"

Fields

public FormalParameter exportFormat

Indicates the export format name

public FormalParameter specialEncoding

Indicates the list of special encoding to be used.

Public Constructors

public ReportExportIServerTransform ()

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public Class getSupportedBeanType ()

return the bean type supported by this transform.

Returns
  • the bean type

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderShell (MarkupOutput out)

Overwrites the default implementation to prevent a shell from being rendered.
Calls checkStatus(MarkupOutput)

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful". Gets the binary data from IServer and appends it to the Markupoutput

Parameters
mo output by this transform

Protected Methods

protected ExportBeanHelper getExportBeanHelper ()

Returns the export bean helper used to setup the export headers.
This method can be overwritten to set the File Name if needed.

Returns
  • the export bean helper used to setup the export headers.