Package com.microstrategy.web.app.transforms

Class 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

    • Field Detail

      • _styleName

        protected FormalParameter _styleName
        Deprecated.
        We do not use a transform to render the report bean, we use ExportBean.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

        protected FormalParameter _isCSV
        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.

      • _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

    • Constructor Detail

      • ReportExportPlainTextTransform

        public ReportExportPlainTextTransform()
        Default empty constructor.
        Initialize formal parameters.

    • Method Detail

      • 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 class AbstractReportTransform
        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

        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 report
        mo - 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

      • 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 object
        rb - 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 interface Transform
        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 <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.
        Overrides:
        renderShell in class AbstractAppTransform
        Parameters:
        out - output by this transform
        Since:
        MicroStrategy Web 8.0.0