Common Parameters to all Report Constructors

When looking at Parameters and Constructors, most of the parameters are common to all reports. We will look at those here:

String filename,                  1
String title,                     2
String units,                     3
AttributeStore sourceDataTable,   4
String reselectExpression,        5
int periods,                      6
String additionalHTML,            7 
boolean percent                   8
boolean annualize                 9

1

filename - The basename to be used for output from this report. This name must be unique with respect to other reports added to the report writer. The name should NOT contain a filename extension since the report will automatically add ".html", ".png", or ".csv" as appropriate. If the report is to be grouped into a folder, the folder should also appear here ("folder/subfolder/filename").

2

title - The title to be displayed in the HTML and PNG sub-reports. The report writer will automatically append the Scenario Name to the report title. The report will appear in the directory tree with this title, as well as in the Index Report it belongs to.

3

units - The units of measure to be displayed on the Y-axis of the PNG sub-report.

4

sourceDataTable - The table containing the data to be summarized. This is most often the block table, however, you must designate the target table for the Multiple Target Report and the TargetLimitReport. It could also be the route table (i.e. Route Cost Report) or a crosstab table (calculated from any other table) or the date from a shape file.

5

reselectExpression - The reselectExpression allows you to specify which rows of the datasourceTable are to be used to calculate cell values. If no expression is entered (null) all rows of the data table will be summed for the cell values. The expression is an SQL-like syntax that must evaluate to True/False. If this option does not exist in your constructor, then by default, all rows of the sourceDataTable will be used.

6

periods - This parameter allows the user to specify which periods should be included in the report. Remember to include another period for P:0 (40 periods would be 41 to include initial conditions). An array can be used here if necessary. If this option does not exist in the constructor then by default, all periods of the planning horizon will be represented on the x-axis of the .PNG report and rows of the .HTML table. Only values from the specified period list will be used, meaning reports can be customized to represent only certain periods of interest. For example: this array specifies that only Periods 1-5 should be represented in this report.

	new int[] {1,2,3,4,5},
      

7

additionalHTML - Artibrary HTML format text that can be added to the HTML sub-report. This text can contain explanatory text, display a coporate logo, or provide a hyper-link to a related table. This text is displayed below the embedded PNG bar chart: General Report Layout.

8

computePercent - A boolean value that indicates if the cell data should be converted to percent of the row total. Percent format data can assist in showing change in relative composition over time. If the data is best represented as a percent, indicate true or if absolute values are more appropriate indicate false.

9

annualize -This parameter allows you to specify by either true of false, whether, you would like the figures to be by period or year (annualized).