Class ShortageReport

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

public class ShortageReport extends Report
This report summarizes target shortages for active targets.
  • Field Details

  • Constructor Details

    • ShortageReport

      public ShortageReport(String filename, String title, AttributeStore as, String column, String additionalHTML)
      filename - The file name of the report
      title - The title of the report
      as - The object reference to the Target Table
      column - The column containing the values to summarize. This is usually 'CURRENT' for current values or 'SHORTAGE' for shortage values.
      additionalHTML - Additional HTML text to be included in the report.
  • Method Details

    • getColumn

      public String getColumn()
    • getAdditionalHTML

      public String getAdditionalHTML()
    • 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