Package com.microstrategy.web.app.transforms

Class ReportExportIServerTransform

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

All Implemented Interfaces:

AppTransform, Transform

public class ReportExportIServerTransform
extends AbstractExportTransform

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 EnumWebReportExecutionModes.REPORT_MODE_EXCEL for Excel with formatting or EnumWebReportExecutionModes.REPORT_MODE_CSV for Excel with Plaintext, CSV or plaintext.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

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

AbstractExportTransform.IServerPlaintextExportStreamingContext

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

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ENCODING_CHARSET_SEPARATOR
static java.lang.String	ENCODING_CLASS_SEPARATOR
static java.lang.String	ENCODING_MAP_SEPARATOR
FormalParameter	exportFormat	Indicates the export format name
static java.lang.String	FP_EXPORT_FORMAT	Constant for the name of the exportFormat Formal Parameter.
static java.lang.String	FP_SPECIAL_ENCODING	Constant for the name of the specialEncoding Formal Parameter.
FormalParameter	specialEncoding	Indicates the list of special encoding to be used.

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

BYTE_ORDER_MARK

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
ReportExportIServerTransform()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Return description for this Transform
protected ExportBeanHelper	getExportBeanHelper()	Returns the export bean helper used to setup the export headers.
java.lang.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".

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

appendBinaryExportData, setupExportHeaders

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, 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, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

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

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

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

addFormalParam, canTransform, 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

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

specialEncoding

public FormalParameter specialEncoding

Indicates the list of special encoding to be used.

Since:

MicroStrategy Web 9.0.1

exportFormat

public FormalParameter exportFormat

Indicates the export format name

FP_SPECIAL_ENCODING

public static final java.lang.String FP_SPECIAL_ENCODING

Constant for the name of the specialEncoding Formal Parameter.

Since:

MicroStrategy Web 9.0.1

See Also:

specialEncoding, Constant Field Values

FP_EXPORT_FORMAT

public static final java.lang.String FP_EXPORT_FORMAT

Constant for the name of the exportFormat Formal Parameter.

See Also:

exportFormat, Constant Field Values

ENCODING_MAP_SEPARATOR

public static final java.lang.String ENCODING_MAP_SEPARATOR

See Also:

Constant Field Values

ENCODING_CLASS_SEPARATOR

public static final java.lang.String ENCODING_CLASS_SEPARATOR

See Also:

Constant Field Values

ENCODING_CHARSET_SEPARATOR

public static final java.lang.String ENCODING_CHARSET_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ReportExportIServerTransform

public ReportExportIServerTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Description copied from class: AbstractAppTransform

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.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - the bean to transform.

renderShell

public void renderShell(MarkupOutput out)

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

Overrides:

renderShell in class AbstractAppTransform

Parameters:

out - output by this transform

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput mo)

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

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

mo - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getExportBeanHelper

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.

Specified by:

getExportBeanHelper in class AbstractExportTransform

Returns:

the export bean helper used to setup the export headers.

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

getDescription

public java.lang.String getDescription()

Return description for this Transform

Returns:

description for this Transform