Package com.microstrategy.web.app.transforms

Class DocumentExportTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class DocumentExportTransform
extends DocumentSimpleTransform
    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.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • exportFormat

        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

  • Constructor Detail

    • DocumentExportTransform

      public DocumentExportTransform()
      Default no argument constructor.

  • Method Detail

    • initializeTransform

      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
      Specified by:
      initializeTransform in interface AppTransform
      Overrides:
      initializeTransform in class AbstractDocumentTransform
      Parameters:
      data - the bean to transform.
      Since:
      MicroStrategy Web 8.0.0

    • getDescription

      public java.lang.String getDescription()
      Return description for this Transform
      Specified by:
      getDescription in interface Transform
      Overrides:
      getDescription in class DocumentSimpleTransform
      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'

    • renderPageByInfo

      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.

    • 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.2