Package ca.spatial.patchworks

Class PatchReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.patchworks.PatchReport

All Implemented Interfaces:

Selectable<Report>, Comparable<Report>

public class PatchReport
extends Report

The PatchReport class describes the area distribution of connected patches on a landscape.

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	This field describes the multiple renderings that are supported by the report.

Fields inherited from class ca.spatial.reportwriter.Report

AREA, LINE, PIE, SIDE_BY_SIDE_BARS, STACKED_BARS

Constructor Summary

Constructors

Constructor	Description
PatchReport(String filename, String title, String units, AttributeStore sourceDataTable, String reselectExpression, Topology topology, String valueExpression, RangeLabel[] classes, int periods, String additionalHTML)	Deprecated. Use the other constructor.
PatchReport(String filename, String title, String units, AttributeStore sourceDataTable, String reselectExpression, Topology topology, String valueExpression, RangeLabel[] classes, 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.
RangeLabel[]	getClasses()
String	getExpression()
String	getHTMLText()
int[]	getPeriods()
String	getReselectExpression()
Topology	getTopology()
String[]	getTypes()	An accessor function to retrieve the list of report types supported by this report.
String	getUnits()
void	setClasses(RangeLabel[] classes)
void	setExpression(String expression)
void	setHTMLText(String text)
PatchReport	setPeriods(int[] periodList)
void	setReselectExpression(String expression)
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

This field describes the multiple renderings that are supported by the report. In this case the report supports html, csv, and png.

Constructor Details

PatchReport

public PatchReport(String filename,
 String title,
 String units,
 AttributeStore sourceDataTable,
 String reselectExpression,
 Topology topology,
 String valueExpression,
 RangeLabel[] classes,
 String additionalHTML)

PatchReport

public PatchReport(String filename,
 String title,
 String units,
 AttributeStore sourceDataTable,
 String reselectExpression,
 Topology topology,
 String valueExpression,
 RangeLabel[] classes,
 int periods,
 String additionalHTML)

Deprecated.

Use the other constructor.

Method Details

getUnits

public String getUnits()

setUnits

public void setUnits(String units)

setExpression

public void setExpression(String expression)

getExpression

public String getExpression()

setReselectExpression

public void setReselectExpression(String expression)

getReselectExpression

public String getReselectExpression()

getClasses

public RangeLabel[] getClasses()

setClasses

public void setClasses(RangeLabel[] classes)

getHTMLText

public String getHTMLText()

setHTMLText

public void setHTMLText(String text)

getTopology

public Topology getTopology()

setPeriods

public PatchReport setPeriods(int[] periodList)

getPeriods

public int[] getPeriods()

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