Package ca.spatial.reportwriter

Class TargetLimitReport

java.lang.Object
ca.spatial.reportwriter.Report
ca.spatial.reportwriter.RangeIndicatorChartReport
ca.spatial.reportwriter.TargetLimitReport
All Implemented Interfaces:
Selectable<Report>, Comparable<Report>
public class TargetLimitReport extends RangeIndicatorChartReport
This class creates a chart that show account values along with the minimum and maximum target values. All values are automatically extracted from the target table. 
   reportWriter.addReport(new TargetLimitReport("volume/SPF", 
               "Annual SPF Volume harvested by FMU", 
               control.getTargetTable(), 
               "m3/yr",
               "FMU",
               "Annual Harvest",
               "product.Yield.FmuToAnywhere.SPF.*", 
               true, 
               ""));

Target limit chart

Note that this class is new and is subject to change.

See Also:
RangeIndicatorChartReport

  • Field Details

    • TYPES

      public static final String[] TYPES

  • Constructor Details

    • TargetLimitReport

      public TargetLimitReport​(String filename, String title, AttributeStore as, String units, String categoryCaption, String valueCaption, String targetPattern, boolean annualize, String html)
      This constructor is a convenience to create chart from values in the TargetTable. The upper and lower ranges (max and min targets) are automatically plotted.
      Parameters:
      filename - The name to save the file
      title - The report title
      as - A reference to the target table.
      units - Units to be displayed on the y axis
      categoryCaption - the caption on the x axis describing the categories
      valueCaption - The legend caption for the simulation data
      targetPattern - The pattern to use to select columns from the target table.
      annualize - A flag to indicate if the values should be annualized. If true then values from period 0 (prior to the start of the simulation) are not shown. All other values are divided by the width of the period.
      html - Additional HTML text to be displayed in the report.

    • TargetLimitReport

      public TargetLimitReport​(String filename, String title, AttributeStore as, String units, String categoryCaption, String valueCaption, String[] targets, String[] aliases, boolean annualize, String html)
      This constructor is a convenience to create chart from values in the TargetTable. The upper and lower ranges (max and min targets) are automatically plotted.
      Parameters:
      filename - The name to save the file
      title - The report title
      as - A reference to the target table.
      units - Units to be displayed on the y axis
      categoryCaption - the caption on the x axis describing the categories
      valueCaption - The legend caption for the simulation data
      targets - The list of targets from the target table.
      aliases - A list of names to use in place of the targets.
      annualize - A flag to indicate if the values should be annualized. If true then values from period 0 (prior to the start of the simulation) are not shown. All other values are divided by the width of the period.
      html - Additional HTML text to be displayed in the report.

  • Method Details

    • setPattern

      public void setPattern​(String pattern)

    • getPattern

      public String getPattern()

    • 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.
      Overrides:
      doReport in class RangeIndicatorChartReport
      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.
      Overrides:
      getTypes in class RangeIndicatorChartReport