Package ca.spatial.patchworks

Class ShortageReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.patchworks.ShortageReport

All Implemented Interfaces:

Selectable<Report>, Comparable<Report>

public class ShortageReport
extends Report

This report summarizes target shortages for active targets.

Nested Class Summary

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

Report.GetNodesAt

Field Summary

Fields

Modifier and Type	Field	Description
static int	OBJECTIVE
static int	TARGET
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
ShortageReport(String filename, String title, AttributeStore as, String column, String additionalHTML)

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	getAdditionalHTML()
String	getColumn()
String[]	getTypes()	An accessor function to retrieve the list of report types supported by 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

TARGET

public static final int TARGET

See Also:

Constant Field Values

OBJECTIVE

public static final int OBJECTIVE

See Also:

Constant Field Values

TYPES

public static final String[] TYPES

Constructor Details

ShortageReport

public ShortageReport(String filename,
 String title,
 AttributeStore as,
 String column,
 String additionalHTML)

Parameters:

filename - The file name of the report

title - The title of the report

as - The object reference to the Target Table

column - The column containing the values to summarize. This is usually 'CURRENT' for current values or 'SHORTAGE' for shortage values.

additionalHTML - Additional HTML text to be included in the report.

Method Details

getColumn

public String getColumn()

getAdditionalHTML

public String getAdditionalHTML()

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