Class TreeReport

All Implemented Interfaces:
Selectable<Report>, Comparable<Report>

public class TreeReport extends Report
This class creates a hierarchical list of reports (reports sorted within folders) that is used by the 'Navigator' feature of the Patchworks web based reports.

This report is not intended to be used by applications programmers.

  • Field Details

    • TYPES

      public static final String[] TYPES
  • Constructor Details

    • TreeReport

      public TreeReport(String filename, String title, ReportWriter rw)
      Create a new instance of the TreeReport.
      filename - The base filename part (without any extension).
      title - A title to be given to the report. The title is ignored since it will not show up in the report index.
      rw - The ReportWriter object that this TreeReport is to be embedded within.
  • Method Details

    • getLength

      public long getLength(String filename, Map<String,​Object> param)
      Description copied from class: Report
      Return the length of this report, in bytes. In most cases the length of the report is unknown because it is generated on the fly. By default we will return a -1 to indicate an unknown length. Specialized classes can over ride this.
      getLength in class Report
    • getRw

      public ReportWriter getRw()
    • 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
      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