Class PatchReport

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

public class PatchReport extends Report
The PatchReport class describes the area distribution of connected patches on a landscape.
  • Field Details

    • TYPES

      public static final String[] TYPES
      This field describes the multiple renderings that are supported by the report. In this case the report supports html, csv, and png.
  • Constructor Details

  • Method Details

    • getUnits

      public String getUnits()
    • setUnits

      public void setUnits(String units)
    • setExpression

      public void setExpression(String expression)
    • getExpression

      public String getExpression()
    • setReselectExpression

      public void setReselectExpression(String expression)
    • getReselectExpression

      public String getReselectExpression()
    • getClasses

      public RangeLabel[] getClasses()
    • setClasses

      public void setClasses(RangeLabel[] classes)
    • getHTMLText

      public String getHTMLText()
    • setHTMLText

      public void setHTMLText(String text)
    • getTopology

      public Topology getTopology()
    • setPeriods

      public PatchReport setPeriods(int[] periodList)
    • getPeriods

      public int[] getPeriods()
    • 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