Package ca.spatial.reportwriter

Class PeriodValueReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.reportwriter.PeriodValueReport

All Implemented Interfaces:

Selectable<Report>, Comparable<Report>

public class PeriodValueReport
extends Report

This class produces a report that shows periods along the rows and specified values along the columns,

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
PeriodValueReport(String filename, String title, String units, AttributeStore as, String[] expressions, String[] labels, String reselectExpression, int[] periods, String htmlText, boolean percent)
PeriodValueReport(String filename, String title, String units, AttributeStore as, String pattern, String reselectExpression, int[] periods, String htmlText, boolean percent)	Create a PeriodValue report.
PeriodValueReport(String filename, String title, String units, AttributeStore as, String pattern, String reselectExpression, int periods, String htmlText, boolean percent)	Deprecated.

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	getExpression()
String[]	getExpressions()
String	getHTMLText()
String[]	getLabels()
String	getPattern()
boolean	getPercent()
int[]	getPeriods()
AttributeStore	getStore()
String[]	getTypes()	An accessor function to retrieve the list of report types supported by this report.
String	getUnits()
void	setExpression(String reselectExpression)
void	setExpressions(String[] labels, String[] exprs)
void	setHTMLText(String text)
void	setPattern(String pattern)
void	setPercent(boolean percent)
void	setPeriods(int period)
void	setPeriods(int[] periods)
void	setStore(AttributeStore as)
void	setUnits(String units)

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

PeriodValueReport

public PeriodValueReport(String filename,
 String title,
 String units,
 AttributeStore as,
 String pattern,
 String reselectExpression,
 int[] periods,
 String htmlText,
 boolean percent)

Create a PeriodValue report.

Parameters:

filename - The name that the report will be saved to.

title - The title of the report.

units - The unit of measure of the values in the report.

as - The source data table.

pattern - The pattern of the column names to use. All data columns matching this pattern will be included in the report.

reselectExpression - A boolean expressin used to limit the number of source data records used to create this report.

periods - An array of periods of interest for this report.

htmlText - Additional text that can be used to document the report.

percent - A boolean used to indicate if the values should be shown in percentage format.

PeriodValueReport

public PeriodValueReport(String filename,
 String title,
 String units,
 AttributeStore as,
 String[] expressions,
 String[] labels,
 String reselectExpression,
 int[] periods,
 String htmlText,
 boolean percent)

PeriodValueReport

public PeriodValueReport(String filename,
 String title,
 String units,
 AttributeStore as,
 String pattern,
 String reselectExpression,
 int periods,
 String htmlText,
 boolean percent)

Deprecated.

Create a PeriodValue report.

Parameters:

filename - The name that the report will be saved to.

title - The title of the report.

units - The unit of measure of the values in the report.

as - The source data table.

pattern - The pattern of the column names to use. All data columns matching this pattern will be included in the report.

reselectExpression - A boolean expressin used to limit the number of source data records used to create this report.

htmlText - Additional text that can be used to document the report.

percent - A boolean used to indicate if the values should be shown in percentage format.

Method Details

getUnits

public String getUnits()

setUnits

public void setUnits(String units)

getStore

public AttributeStore getStore()

setStore

public void setStore(AttributeStore as)

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

setExpressions

public void setExpressions(String[] labels,
 String[] exprs)

getExpressions

public String[] getExpressions()

getLabels

public String[] getLabels()

getHTMLText

public String getHTMLText()

setHTMLText

public void setHTMLText(String text)

getPercent

public boolean getPercent()

setPercent

public void setPercent(boolean percent)

getPeriods

public int[] getPeriods()

setPeriods

public void setPeriods(int[] periods)

setPeriods

public void setPeriods(int period)

getExpression

public String getExpression()

setExpression

public void setExpression(String reselectExpression)

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