Parameters and Constructors


Prev		Next

	  public MultipleTargetReport (String filename,      
                                       String title,                     
                                       String units,                    
                                       AttributeStore sourceDataTable,   
                                       String targetPattern,             
                                       String expression,                
                                       String additionalHTML,           
                                       boolean computePercent)

targetPattern - A string containing the prefix of the targets of interest. This will allow the report to search for ALL targets beginning with this prefix. 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.")

expression - An expression describing the data value to be displayed in the cells of the table. The expression can refer to any column in the Target Table. Most often this would be "CURRENT", as this reflects the actual value achieved in the simulation. The actual value contained in the specified column could be written in the cells, or the value could be modified to represent other information. For example "CURRENT/PERIODWIDTH" would create a new value derived from the values contained in the two columns labelled "CURRENT" and "PERIODWIDTH".

Important

	Important
The BlockTable and TargetTable are internal Patchworks tables that keep track of all the necessary 'book keeping' while the model is running. These tables are most often used to create reports and are referenced through the method `control.getTargetTable()` or `control.getBlockTable()`. If for some reason you wish to construct a report based on information from attributes of a shapefile or coverage it's not a problem! To do this the file can be opened and given a variable name to be used when defining any type of report. Use the `GeoRelationalStore` class with the `open` method (see the Patchworks Appication Programming Interface (API) Reference for more detailed info). GeoRelationalStore fragment = GeoRelationalStore.open("../data/fragments.shp"); Now the variable name `fragment` can be used at the `dataSourceTable` when defining reports. This method can be used anywhere in the PIN file to open shape files and coverages.

The BlockTable and TargetTable are internal Patchworks tables that keep track of all the necessary 'book keeping' while the model is running. These tables are most often used to create reports and are referenced through the method control.getTargetTable() or control.getBlockTable(). If for some reason you wish to construct a report based on information from attributes of a shapefile or coverage it's not a problem!

To do this the file can be opened and given a variable name to be used when defining any type of report. Use the GeoRelationalStore class with the open method (see the Patchworks Appication Programming Interface (API) Reference for more detailed info).

	  GeoRelationalStore fragment =
	  GeoRelationalStore.open("../data/fragments.shp");

Now the variable name fragment can be used at the dataSourceTable when defining reports. This method can be used anywhere in the PIN file to open shape files and coverages.