Parameters and Constructors

Figure 141. Period Value Report Constructor

public PeriodValueReport(String filename,                1
                         String title,                   2
                         String units,                   3
                         AttributeStore sourceDataTable, 4
                         String pattern,            5
                         String reselectExpression,      6
                         int periods,                    7
                         String additionalHTML,          8 
                         boolean percent)                9


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").


title - The title to be displayed in the HTML and PNG sub-reports. The report writer will automatically append the Scenario Name to the 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.


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


sourceDataTable - The table containing the data to be summarized.


pattern - A string containing the prefix of the attribute of interest. This will allow the report to search for ALL columns beginning with this prefix. The Period Value Report searches the column headings of the source data table for the attribute prefixes, whereas the Standard Report will search the rows for unique targets. This prefix will be eliminated when used in HTML table column headings, therefore include the last "." so it will not show up in headings. ("product.area.")


reselectExpression - The reselectExpression allows the user 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.


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.


additionalHTML - Artibrary HTML format text that can be added in 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.


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.