Class ReportExportPlainTextTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class ReportExportPlainTextTransform extends AbstractReportTransform implements LayoutTransform
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected FormalParameter
_isCSV
Deprecated.we now read this value from the export format type of the export format property of theExportBean
protected FormalParameter
_isExcel
Deprecated.We now read this value fromExportBean.getExportFormat()
and then ask forExportFormat.isExcel()
protected FormalParameter
_renderOldStyleFilterDetails
This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSEprotected FormalParameter
_styleName
Deprecated.We do not use a transform to render the report bean, we useExportBean.getExportData()
protected FormalParameter
_stylePageByInfo
This formal parameter determines the style to be used to transform the report bean to display the page by information.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
BLANK_SUBSET_REPORT_ID, BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara
-
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 ReportExportPlainTextTransform()
Default empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.lang.String
cleanTextForExport(java.lang.String text)
This methods cleans a string to be displayed in Excel.java.lang.String
getDescription()
Return description for this Transformprotected TransformInstance
getPageByTransform(ReportBean rb)
void
initializeProperties()
Initialize some properties for the transform.void
renderFilterDetails(MarkupOutput mo)
Renders the filter detailsvoid
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)
Renders the Page-by information displayed after the report name when reports have elements on the page-by axis.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
renderReport(MarkupOutput mo)
Renders the reportvoid
renderReportName(MarkupOutput mo)
Renders the report name displayed at the top of the page.void
renderReportName(MarkupOutput mo, java.lang.String reportName)
Renders the report name displayed at the top of the page.void
renderReportName(java.lang.String reportName, MarkupOutput mo)
Deprecated.void
renderShell(MarkupOutput out)
Generates the shell for this Transform.void
transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
canTransform, generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatus, getReportStatusDescriptorKey, getRepromptEvent, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, initializeTransform, initializeWebComponent, isCubeReport, isDatamart, isDesignMode, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, useBuiltInFormat
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, 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, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestWaitingForUserInput
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, 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.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
_isExcel
@Deprecated protected FormalParameter _isExcel
Deprecated.We now read this value fromExportBean.getExportFormat()
and then ask forExportFormat.isExcel()
This formal parameter determines whether the application to Export to is Excel.
Allowed Values: TRUE/FALSE.
-
_styleName
@Deprecated protected FormalParameter _styleName
Deprecated.We do not use a transform to render the report bean, we useExportBean.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.
-
_isCSV
@Deprecated protected FormalParameter _isCSV
Deprecated.we now read this value from the export format type of the export format property of theExportBean
This formal parameter determines whether the pplication should export in a CSV format.
Allowed Values: TRUE/FALSE.
-
_stylePageByInfo
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.
-
_renderOldStyleFilterDetails
protected FormalParameter _renderOldStyleFilterDetails
This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE- Since:
- MicroStrategy Web 8.0.0
-
-
Method Detail
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
mo
- the output object- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
initializeProperties
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.- Overrides:
initializeProperties
in classAbstractReportTransform
- Since:
- MicroStrategy Web 8.0.0
-
renderHeader
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- Since:
- MicroStrategy Web 8.0.2
-
renderReportName
public void renderReportName(MarkupOutput mo)
Renders the report name displayed at the top of the page.- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 8.0.0
-
renderReportName
@Deprecated public void renderReportName(java.lang.String reportName, MarkupOutput mo)
Deprecated.Renders the report name displayed at the top of the page.- Parameters:
reportName
- name of the reportmo
- the output object
-
renderReportName
public void renderReportName(MarkupOutput mo, java.lang.String reportName)
Renders the report name displayed at the top of the page.- Parameters:
reportName
- name of the reportmo
- the output object- Since:
- MicroStrategy Web 8.0.1
-
renderPageByInfo
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- Since:
- MicroStrategy Web 8.0.0
-
getPageByTransform
protected TransformInstance getPageByTransform(ReportBean rb)
- Since:
- MicroStrategy Web 8.0.0
-
renderPageByInfo
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 objectrb
- Report bean to export
-
renderFilterDetails
public void renderFilterDetails(MarkupOutput mo)
Renders the filter details- Parameters:
mo
- MarkupOutput the output object- Since:
- MicroStrategy Web 8.0.0
-
renderReport
public void renderReport(MarkupOutput mo)
Renders the report- Parameters:
mo
- MarkupOutput the output object- Since:
- MicroStrategy Web 8.0.0
-
renderFooter
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- Since:
- MicroStrategy Web 8.0.2
-
renderNewLine
public void renderNewLine(MarkupOutput mo)
Renders A new line (carriage return)- Parameters:
mo
- MarkupOutput the output object- Since:
- MicroStrategy Web 8.0.0
-
cleanTextForExport
protected java.lang.String cleanTextForExport(java.lang.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
-
getDescription
public java.lang.String getDescription()
Return description for this Transform- Specified by:
getDescription
in interfaceTransform
- Returns:
- description for this Transform
-
renderShell
public void renderShell(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the shell for this Transform.
The shell is a
The attributes to append to this<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.<div>
are obtained from thegetAttributesShellDiv
method; the style from thegetStyleShellDiv
method.
This method callsrenderCssLink
andcheckStatus
to generate the Transform's content.- Overrides:
renderShell
in classAbstractAppTransform
- Parameters:
out
- output by this transform- Since:
- MicroStrategy Web 8.0.0
-
-