Class CompareReport

java.lang.Object
ca.spatial.reportwriter.Report
ca.spatial.reportwriter.CompareReport
All Implemented Interfaces:
Selectable<Report>, Comparable<Report>
Direct Known Subclasses:
RangeIndicatorCompareReport

public class CompareReport extends Report
This report class will read the saved values from several scenarios, extract a single indicator, and produce a line chart that compares the scenarios.
  • Field Details

    • TYPES

      public static final String[] TYPES
  • Constructor Details

    • CompareReport

      public CompareReport(String filename, String title, ReportWriter rw, ReportWriter cw, String[] paths, String[] columns, String additionalHtml)
      Create a CompareReport.
      Parameters:
      filename - The name the report will be saved to.
      title - The title of the report.
      rw - A reference to the ReportWriter containing the reports to compare.
      cw - A reference to the ReportWriter that contains this report.
      paths - The list of reports within the scenarios to compare
      columns - The columns within the reports to compare.
      additionalHtml - A string of HTML text that will be included in the report
    • CompareReport

      public CompareReport(String filename, String title, ReportWriter rw, ReportWriter cw, String[] paths, String[] columns)
      Create a CompareReport.
      Parameters:
      filename - The name the report will be saved to.
      title - The title of the report.
      rw - A reference to the ReportWriter containing the reports to compare.
      cw - A reference to the ReportWriter that contains this report.
      paths - The list of reports within the scenarios to compare
      columns - The columns within the reports to compare.
    • CompareReport

      public CompareReport(String filename, String title, ReportWriter rw, Vector list, String[] paths, String[] columns)
      Create a CompareReport.
      Parameters:
      filename - The name the report will be saved to.
      title - The title of the report.
      rw - A reference to the ReportWriter containing the reports to compare.
      list - The list of scenarios to compare
      paths - The list of reports within the scenarios to compare
      columns - The columns within the reports to compare.
  • Method Details

    • getReportWriter

      public ReportWriter getReportWriter()
    • getComparisonWriter

      public ReportWriter getComparisonWriter()
    • setReportWriter

      public void setReportWriter(ReportWriter reportWriter)
    • getList

      public Vector getList()
    • setList

      public void setList(Vector list)
    • getPaths

      public String[] getPaths()
    • setPaths

      public void setPaths(String[] paths)
    • getColumns

      public String[] getColumns()
    • setColumns

      public void setColumns(String[] columns)
    • getHTMLText

      public String getHTMLText()
      Get the HTML text data that is used in this report.
    • setHTMLText

      public void setHTMLText(String text)
      Set the HTML text data that is used in this report.
    • getYCaption

      public String getYCaption()
      Get the caption to be used on the y-axis
    • setYCaption

      public CompareReport setYCaption(String caption)
      Set the caption to be used on the y-axis
    • doReport

      public ca.spatial.reportwriter.Report.DataCache doReport(String filename, PrintStream out, Map<String,​Object> param, ca.spatial.reportwriter.Report.DataCache cache)
      Description copied from class: Report
      The method used by the report writer to format the requested report. This method is implemented in every custom report. Application programs generally do not need to call this method, but instead use the report writer methods to obtain reports.
      Specified by:
      doReport in class Report
      Parameters:
      filename - The full name of the report to be printed, including the extension of the sub-report (if any).
      out - The output stream to print output on to.
      param - A HashMap containing parameters that modify the report (for example the scenario name).
    • getTypes

      public String[] getTypes()
      Description copied from class: Report
      An accessor function to retrieve the list of report types supported by this report. See the documentation for the TYPES variable for the list of sub-types.
      Specified by:
      getTypes in class Report