Package ca.spatial.patchworks

Class RouteReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.patchworks.RouteReport

All Implemented Interfaces:

Selectable<Report>, Comparable<Report>

public class RouteReport
extends Report

This class defines a report that saves a route to a destination. The route is saved in a CSV format file, and can be reloaded into the simulation to restore the direction of flow in the network.

Nested Class Summary

Nested classes/interfaces inherited from class ca.spatial.reportwriter.Report

Report.GetNodesAt

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	TYPES	An array holding the sub-types of this report.

Fields inherited from class ca.spatial.reportwriter.Report

AREA, LINE, PIE, SIDE_BY_SIDE_BARS, STACKED_BARS

Constructor Summary

Constructors

Constructor	Description
RouteReport(String filename, String title, ca.spatial.patchworks.Route route)	Construct a RouteReport

Method Summary

Modifier and Type	Method	Description
ca.spatial.reportwriter.Report.DataCache	doReport(String filename, PrintStream out, Map<String,Object> param, ca.spatial.reportwriter.Report.DataCache cache)	The method used by the report writer to format the requested report.
String	getLabel()	Return the destination name of this route
ca.spatial.patchworks.Route	getRoute()	Return a reference to the route that this report is based on
String[]	getTypes()	An accessor function to retrieve the list of report types supported by this report.
void	setRoute(ca.spatial.patchworks.Route route)	Set the route used for this report

Methods inherited from class ca.spatial.reportwriter.Report

addDefaultParam, chartImg, compareTo, csvLink, doesAnyTypes, doesCSV, doesGIF, doesHTML, doesPNG, doesType, encodeFileURL, encodeURL, endMainContent, escapeRegexChars, footer, formatColumnHeadings, formatColumnHeadings, getAdditionalFiles, getAttributeStore, getBasepart, getBasepart, getDefaultFilename, getDisplayFormat, getExtension, getExtension, getFilename, getFolderpart, getFolderpart, getLength, getNamepart, getNamepart, getPathToRoot, getReportFor, getTitle, header, htmlText, indexLink, interpolateParams, isDhandler, isIndexed, isSelected, parentIndex, patternToRegex, setAttributeStore, setDefaultParams, setDisplayFormat, setIndexed, setSelected, setTitle, toString, uniqueLabels

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TYPES

public static final String[] TYPES

An array holding the sub-types of this report. In the case of the RouteReport this array is null. The report only creates a CSV file and there are no sub-types.

Constructor Details

RouteReport

public RouteReport(String filename,
 String title,
 ca.spatial.patchworks.Route route)

Construct a RouteReport

Parameters:

filename - the filename to be used for this report

title - the report title

route - the route used as the basic of this report

Method Details

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

Parameters:

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

getLabel

public String getLabel()

Return the destination name of this route

getRoute

public ca.spatial.patchworks.Route getRoute()

Return a reference to the route that this report is based on

setRoute

public void setRoute(ca.spatial.patchworks.Route route)

Set the route used for this report

Parameters:

route - the route to report on

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