Following the constructors and parameter definitions set out above, a Category Pattern Report could be added and defined in the PIN file as follows:
rw.addReport(new CategoryReport("detail/areaTreatedLmu/period10", "Area by LMU and Species code for period 10", "hectares", control.getBlockTable(), "product.Area.managed", "LMU", lmu, new int[] {10}, "Spatial Planning Systems", false));
This PIN file definition of a Category Pattern Report was used to create the above output examples. The filename "detail/areaTreatedLmu/period" creates three files "period10.html, period10.csv, and period10.png" and places them in a subfolder of "detail/areaTreatedLmu". This type of filename definition allows the Report Writer to create the well organized directory tree of folders, subfolders and individual reports.
The title of the report will be "Area by LMU and Species code for period 10" and will be followed by the name of the entire scenario folder. This title will also be used in the PNG sub-report along the top of the bar chart. This stacked bar chart will have "hectares" as the units along the Y-axis.
The columnPrefix
used to search for unique
attribute categories was specified as "product.Area.", therefore
any attribute in the Block Table (control.getBlockTable()) that
began with this prefix was used to create the report. This
prefix was removed when the column headings were created
(managed.DF, managed.LA, ...).
"LMU" is the categoryColumn
being used to
classify the attribute values found with the Prefix into
categories. The variable name 'values' (defined above)
can then be used as the categories
parameter.
This particular report is only gathering information from one period, period 10. More information could have been included in this report by adding more periods to the array list({10,11,12,13}).
The company name "Spatial Planning Systems" was added in the
additionalHTML
parameter and will appear
underneath the embedded PNG bar chart. Finally, the values in
the report are not percentages of the row totals, they are
absolute values specified by setting the
computePercent
parameter to "false".
![]() | Important |
---|---|
The Category Expression report is identical to the Category
Pattern Report, except that instead of simply supplying a
pattern, you will have the option of supplying an expression
that includes the pattern, i.e.
|