Package ca.spatial.patchworks

Class RouteCostReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.patchworks.RouteCostReport

All Implemented Interfaces:

Selectable<Report>, Comparable<Report>

public class RouteCostReport
extends Report

This report summarizes costs and flows through a route. The report creates output in HTML, CSV and PNG format.

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

Fields inherited from class ca.spatial.reportwriter.Report

AREA, LINE, PIE, SIDE_BY_SIDE_BARS, STACKED_BARS

Constructor Summary

Constructors

Constructor	Description
RouteCostReport(String filename, String title, AttributeStore route)

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	getDistUnits()	Deprecated. Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.
double	getDivisor()	Deprecated. Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.
String	getScaledUnits()	Deprecated. Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.
String[]	getTypes()	An accessor function to retrieve the list of report types supported by this report.
RouteCostReport	setDistUnits(String units)	Deprecated. Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.
RouteCostReport	setDivisor(double divisor)	Deprecated. Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.
RouteCostReport	setScaledUnits(String units)	Deprecated. Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

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

Constructor Details

RouteCostReport

public RouteCostReport(String filename,
 String title,
 AttributeStore route)

Method Details

setDivisor

@Deprecated
public RouteCostReport setDivisor(double divisor)

Deprecated.

Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

Set the conversion between map distance units and report distance units.

getDivisor

@Deprecated
public double getDivisor()

Deprecated.

Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

Get the conversion between map distance units and report distance units.

setDistUnits

@Deprecated
public RouteCostReport setDistUnits(String units)

Deprecated.

Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

Set the label used for map distance units

getDistUnits

@Deprecated
public String getDistUnits()

Deprecated.

Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

Get the label used for map distance units

setScaledUnits

@Deprecated
public RouteCostReport setScaledUnits(String units)

Deprecated.

Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

Set the label used for reported distance units

getScaledUnits

@Deprecated
public String getScaledUnits()

Deprecated.

Use the Control.setConversionFactors(java.lang.String, java.lang.String, java.lang.String, double, java.lang.String, java.lang.String, double) method.

Get the label used for reported distance units

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

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