Package ca.spatial.reportwriter
Class CompareReport
java.lang.Object
ca.spatial.reportwriter.Report
ca.spatial.reportwriter.CompareReport
- All Implemented Interfaces:
Selectable<Report>
,Comparable<Report>
- Direct Known Subclasses:
RangeIndicatorCompareReport
This report class will read the saved values from several scenarios,
extract a single indicator, and produce a line chart that compares
the scenarios.
-
Nested Class Summary
Nested classes/interfaces inherited from class ca.spatial.reportwriter.Report
Report.GetNodesAt
-
Field Summary
FieldsFields inherited from class ca.spatial.reportwriter.Report
AREA, LINE, PIE, SIDE_BY_SIDE_BARS, STACKED_BARS
-
Constructor Summary
ConstructorsConstructorDescriptionCompareReport(String filename, String title, ReportWriter rw, ReportWriter cw, String[] paths, String[] columns)
Create a CompareReport.CompareReport(String filename, String title, ReportWriter rw, ReportWriter cw, String[] paths, String[] columns, String additionalHtml)
Create a CompareReport.CompareReport(String filename, String title, ReportWriter rw, Vector list, String[] paths, String[] columns)
Create a CompareReport. -
Method Summary
Modifier and TypeMethodDescriptionca.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[]
Get the HTML text data that is used in this report.getList()
String[]
getPaths()
String[]
getTypes()
An accessor function to retrieve the list of report types supported by this report.Get the caption to be used on the y-axisvoid
setColumns(String[] columns)
void
setHTMLText(String text)
Set the HTML text data that is used in this report.void
void
void
setReportWriter(ReportWriter reportWriter)
setYCaption(String caption)
Set the caption to be used on the y-axisMethods 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
-
Field Details
-
TYPES
-
-
Constructor Details
-
CompareReport
public CompareReport(String filename, String title, ReportWriter rw, ReportWriter cw, String[] paths, String[] columns, String additionalHtml)Create a CompareReport.- Parameters:
filename
- The name the report will be saved to.title
- The title of the report.rw
- A reference to the ReportWriter containing the reports to compare.cw
- A reference to the ReportWriter that contains this report.paths
- The list of reports within the scenarios to comparecolumns
- The columns within the reports to compare.additionalHtml
- A string of HTML text that will be included in the report
-
CompareReport
public CompareReport(String filename, String title, ReportWriter rw, ReportWriter cw, String[] paths, String[] columns)Create a CompareReport.- Parameters:
filename
- The name the report will be saved to.title
- The title of the report.rw
- A reference to the ReportWriter containing the reports to compare.cw
- A reference to the ReportWriter that contains this report.paths
- The list of reports within the scenarios to comparecolumns
- The columns within the reports to compare.
-
CompareReport
public CompareReport(String filename, String title, ReportWriter rw, Vector list, String[] paths, String[] columns)Create a CompareReport.- Parameters:
filename
- The name the report will be saved to.title
- The title of the report.rw
- A reference to the ReportWriter containing the reports to compare.list
- The list of scenarios to comparepaths
- The list of reports within the scenarios to comparecolumns
- The columns within the reports to compare.
-
-
Method Details
-
getReportWriter
-
getComparisonWriter
-
setReportWriter
-
getList
-
setList
-
getPaths
-
setPaths
-
getColumns
-
setColumns
-
getHTMLText
Get the HTML text data that is used in this report. -
setHTMLText
Set the HTML text data that is used in this report. -
getYCaption
Get the caption to be used on the y-axis -
setYCaption
Set the caption to be used on the y-axis -
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. -
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.
-