Class DiagnosticsStatisticsTransform

  • All Implemented Interfaces:
    AppTransform, Transform

    public class DiagnosticsStatisticsTransform
    extends AbstractDiagnosticsTransform
    Title: DiagnosticsStatisticsTransform This class is used to display the interface required for changing statistic properties.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Constructor Detail

      • DiagnosticsStatisticsTransform

        public DiagnosticsStatisticsTransform()
    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Returns the description of this transform
        Returns:
        String value with the description of this transform
      • renderDiagnosticOutput

        public void renderDiagnosticOutput​(MarkupOutput out)
        Generates the graphical output for the DiagnosticsBean, which for this transform's definition, will consist on the different options for statistics logging that can be configured by the user.
        The output is inside an HTML TABLE tag for formatting purposes. This method displays the header of the property box, plus the form where the user can specify the values of the different options.
        Specified by:
        renderDiagnosticOutput in class AbstractDiagnosticsTransform
        Parameters:
        out - MarkupOutput instance where to create the HTML output
      • renderFormHiddenInputs

        public void renderFormHiddenInputs​(MarkupOutput out,
                                           WebEvent applyEvent,
                                           WebEvent loadDefaults)
        Add to the global output any hidden inputs and other information that should be rendered for the proper functionality of the form
        Parameters:
        out - MarkupOutput instance where the HTML contents are to be saved.
        applyEvent - WebEvent for applying the changes indicated on the form
        loadDefaults - WebEvent for loading the default values on the form
      • renderStatisticsModeRow

        public void renderStatisticsModeRow​(MarkupOutput out,
                                            WebEvent event,
                                            DiagnosticsBean bean)
        Renders a TR in a table, with two columns, with the information required for the user to customize the statistics mode desired: off, on screen, on a file, etc. If the event or bean are not provided or the argument to search for is not found, nothing will be displayed. It is required that the parent TABLE is already opened. By default renderDiagnosticOutput() takes care of that.
        Parameters:
        out - MarkupOutput instance to contain the HTML to be displayed
        event - WebEvent generated for saving the configuration changes
        bean - DiagnosticsBean currently being transformed
      • renderStatisticsPathRow

        public void renderStatisticsPathRow​(MarkupOutput out,
                                            WebEvent event,
                                            DiagnosticsBean bean)
        Renders a TR in a table, with two columns, with the information required for the user to customize the path where the statistics file is to be saved. If the event or bean are not provided or the argument to search for is not found, nothing will be displayed.
        Parameters:
        out - MarkupOutput instance to contain the HTML to be displayed
        event - WebEvent generated for saving the configuration changes
        bean - DiagnosticsBean currently being transformed
      • renderStatisticsSetup

        public void renderStatisticsSetup​(MarkupOutput out)
        Show the interface related with the diagnostics statistics options: change the mode (off, screen, file, Screen and file) and update the location of the file that will be created. Its contents are inside a table row, with two columns.
        Parameters:
        out - MarkupOutput instance to contain the HTML to be displayed
      • getTitle

        protected java.lang.String getTitle()
        Obtain the title to be displayed by this transform as header of its section
        Specified by:
        getTitle in class AbstractDiagnosticsTransform
        Returns:
        the String to use as title