Package com.microstrategy.web.objects

Interface WebReportPlainTextExportSettings

    • Method Detail

      • setSeparator

        void setSeparator​(java.lang.String separator)
        Sets the separator which will be used between cells upon calling the export method. By default, this will be a comma(,).
        Parameters:
        separator - A string describing the separator to use between cells of an exported report.

      • getSeparator

        java.lang.String getSeparator()
        Returns the current setting of the separator which will be used between cells upon calling the export method. By default, this will be a comma(,).
        Returns:
        The current separator setting.

      • setValuePrefix

        void setValuePrefix​(java.lang.String prefix)
        Sets the prefix which will be prepended at the beginning of each metric value in the exported report. By default, no prefix will be prepended to each metric value.
        Parameters:
        prefix - The prefix to add to metric values upon exporting.

      • getValuePrefix

        java.lang.String getValuePrefix()
        Returns the current setting of the prefix which will be prepended at the beginning of each metric value in the exported report. By default, this value is an empty string.
        Returns:
        The current value postfix setting.

      • setValuePostfix

        void setValuePostfix​(java.lang.String postfix)
        Sets the postfix which will be appended at the end of each metric value in the exported report. By default, no prefix will be appended to each metric value.
        Parameters:
        postfix - The postfix to add to metric values upon exporting.

      • getValuePostfix

        java.lang.String getValuePostfix()
        Returns the current setting of the postfix which will be appended at the end of each metric value in the exported report. By default, this value is an empty string.
        Returns:
        The current value postfix setting.

      • setHeaderPrefix

        void setHeaderPrefix​(java.lang.String prefix)
        Sets the prefix which will be prepended at the beginning of each header cell in the exported report.
        Parameters:
        prefix - The prefix to add to header cells when exporting.

      • getHeaderPrefix

        java.lang.String getHeaderPrefix()
        Returns the current setting of the prefix which will be prepended at the beginning of each header prefix in the exported report. By default, this value is an empty string.
        Returns:
        The current header prefix setting.

      • setHeaderPostfix

        void setHeaderPostfix​(java.lang.String postfix)
        Sets the postfix which will be appended at the end of each header cell in the exported report.
        Parameters:
        postfix - The postfix to add to header cells when exporting.

      • getHeaderPostfix

        java.lang.String getHeaderPostfix()
        Returns the current setting of the postfix which will be appended at the end of each header postfix in the exported report. By default, this value is an empty string.
        Returns:
        The current header postfix setting.

      • setDisplayAttributeForm

        void setDisplayAttributeForm​(boolean displayForm)
        Sets whether to display attribute forms in exported reports. By default, this value is true.
        Parameters:
        displayForm - The new setting for whether to display attribute forms.

      • getDisplayAttributeForm

        boolean getDisplayAttributeForm()
        Returns the current setting of whether to display attribute forms. By default, this value is true.
        Returns:
        Whether attribute forms will be displayed upon exporting.

      • setLayout

        void setLayout​(java.lang.String xml)
        Parameters:
        xml - the layout xml - use WebReportPlainTextLayoutBuilder to construct it
        Since:
        MicroStrategy Web 8.0.1

      • getLayout

        java.lang.String getLayout()
        Returns layout xml.
        Returns:
        layout xml.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        setLayout(String)

      • setTrimWarehouseData

        void setTrimWarehouseData​(boolean value)
        Whether to trim leading and trailing white space for warehouse element data. Also controlled by preference EnumWebPreferences.WebPreferenceTrimWarehouseData
        Setting this overwrites the preference value.
        Parameters:
        value - Whether to trim leading and trailing white space for warehouse element data
        Since:
        MicroStrategy Web 9.0.0

      • setShowHeaderAndFooter

        void setShowHeaderAndFooter​(boolean value)
        Whether to show the Header and Footer on the exported results.
        The default value is true.
        Parameters:
        value - Whether to show the Header and Footer on the exported results

      • isShowHeaderAndFooter

        boolean isShowHeaderAndFooter()
        Whether to show the Header and Footer on the exported results.
        The default value is true.
        Returns:
        Whether to show the Header and Footer on the exported results

      • setVersion

        void setVersion​(int version)
        Parameters:
        version - Excel version as defined in EnumExcelVersion

      • getVersion

        int getVersion()
        Returns:
        Excel version as defined in EnumExcelVersion