Class DecodeReport

java.lang.Object
ca.spatial.reportwriter.Report
ca.spatial.reportwriter.DecodeReport
All Implemented Interfaces:
Selectable<Report>, Comparable<Report>

public class DecodeReport extends Report
This report is responsible for displaying report and map constructors. It is part of the Patchworks system, but not intended for use within scenarios.
  • Field Details

    • TYPES

      public static final String[] TYPES
  • Constructor Details

    • DecodeReport

      public DecodeReport(String filename, String title, ReportWriter rw)
      Parameters:
      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 decoder is to be embedded within.
  • Method Details

    • addDecoder

      public void addDecoder(String key, DecodeObject dobj)
    • 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).
    • isSelected

      public boolean isSelected()
      This report should not be written out when a scenario is saved, so this method always returns false.
      Specified by:
      isSelected in interface Selectable<Report>
      Overrides:
      isSelected in class Report
    • 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