Package ca.spatial.reportwriter

Class TextReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.reportwriter.TextReport

All Implemented Interfaces:

Selectable<Report>, Comparable<Report>

public class TextReport
extends Report

This simple report displays static HTML text. The main purpose of this report is to duplicate static metadata within the Patchworks scenario output.

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
TextReport(String filename, String title, String text)

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	getHTMLText()	Get the current text to be displayed.
String[]	getTypes()	An accessor function to retrieve the list of report types supported by this report.
void	setHTMLText(String text)	Set the text to be displayed.

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 no multiple renderings are supported.

Constructor Details

TextReport

public TextReport(String filename,
 String title,
 String text)

Parameters:

filename - The filename within the web server.

title - The title to display in the table of contents.

text - The HTML text to display as contents. Do not include the html or body tags.

Method Details

getHTMLText

public String getHTMLText()

Get the current text to be displayed.

setHTMLText

public void setHTMLText(String text)

Set the text to be displayed.

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