Uses of Class
ca.spatial.reportwriter.Report

Packages that use Report

Package	Description
ca.spatial.patchworks	The Patchworks application and supporting classes
ca.spatial.reportwriter	Report templates and report writer functions

Uses of Report in ca.spatial.patchworks

Subclasses of Report in ca.spatial.patchworks

Modifier and Type	Class	Description
class	BlockAvailReport	Save block availability
class	BlockReport	Display detailed information about the state of the block.
class	ExclusiveAssignmentReport	Save exclusive option assigments
class	ExclusiveLockReport	Save exclusive option assigments
class	NetworkCostReport	This report summarizes costs and flows through a network.
class	ObjectiveProgressReport	This report will track the progress of specific components of the objective function, and will display charts of how these terms change over the course of the simulation.
class	PatchDetailReport	The PatchDetailReport class lists the sizes of each patch in each period.
class	PatchReport	The PatchReport class describes the area distribution of connected patches on a landscape.
class	RouteCostReport	This report summarizes costs and flows through a route.
class	RouteReport	This class defines a report that saves a route to a destination.
class	ScenarioEventReport	This report logs significant events in the life cycle of a Patchworks simulation run.
class	ShortageReport	This report summarizes target shortages for active targets.
class	StandEventReport	This class defines a report that saves the stand dynamics events for all of the stands in to a CSV file.
class	TreatmentReport	This class defines a report that saves the treatment schedule

Methods in ca.spatial.patchworks that return Report

Modifier and Type	Method	Description
Report	Control.getExclusiveAssignmentReport(String filename, String title, String exclusive)	Get an exclusive assignment report.
Report	Control.getExclusiveLockReport(String filename, String title, String exclusive)	Get an exclusive lock report.
Report	Control.getNetworkCostReport(String filename, String title)	Get a network cost report.
Report	Control.getRouteCostReport(String filename, String title, String destination)	Get a route cost report.
Report	Control.getRouteReport(String filename, String title, String destination)	Get a route report.
Report	Control.getTimingConstraintsReport(String filename, String title)	Get a timing constraints report.

Methods in ca.spatial.patchworks with parameters of type Report

Modifier and Type	Method	Description
void	Patchworks.addReport(Report r)

Uses of Report in ca.spatial.reportwriter

Subclasses of Report in ca.spatial.reportwriter

Modifier and Type	Class	Description
class	BoxAndWhiskerChartReport	Create a chart showing box and whisker statistical data along with account values as a red line and circle.
class	BoxAndWhiskerCompareReport	This report class will read the saved values from several scenarios, extract a single indicator, and produce a line chart that compares the scenarios.
class	CategoryCategoryReport	The CategoryCategoryReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	CategoryExpressionReport	The CategoryExpressionReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	CategoryPatternReport	The CategoryPatternReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	CategoryReport	The CategoryReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	ChartReport
class	ColumnSummaryReport	The ColumnSummaryReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	CompareChartWriter	This class creates a chart based on parameters passed on standard input.
class	CompareReport	This report class will read the saved values from several scenarios, extract a single indicator, and produce a line chart that compares the scenarios.
class	CopyFileReport	This report will copy a file from your file system into the namespace of the internal Patchworks web server.
class	CrosstabReport	This report will display a crosstabulation.
class	DecodeReport	This report is responsible for displaying report and map constructors.
class	ExcelReport	This report allows customization of an Excel workbook.
class	GeneralReport	This class provides support of common parameters for all general reports.
class	IndexReport
class	MapLayoutReport	A MapLayout report prepares multi-page reports consisting of maps, charts, tables and other features.
class	MapReport	Create a map based on the contents of a LayerList object.
class	PeriodCategoryReport	The PeriodCategoryReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	PeriodExpressionReport	This class produces a report that shows periods along the rows and specified values along the columns,
class	PeriodPatternReport
class	PeriodValueReport	This class produces a report that shows periods along the rows and specified values along the columns,
class	PivotTableReport	This class implements a flexible report template.
class	RangeIndicatorChartReport	This class produces charts that show values and a secondary indicator, such as a benchmark value.
class	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.
class	RangePeriodReport	The RangePeriodReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	RangeReport	Deprecated.
class	RasterRemapReport	Create a raster output file, based on remapping codes in from a raster input file.
class	StandardReport	The StandardReport class creates reports that summarize groups of records found in the specified sourceDataTable.
class	TableQueryReport	The TableQueryReport class creates a CSV file that contain a single record for each selected record in the input table, for each requested planning period.
class	TargetLimitReport	This class creates a chart that show account values along with the minimum and maximum target values.
class	TargetReport	This class formats a single target in a standard format.
class	TargetStatusReport	This class formats a single target in a standard format.
class	TargetSummaryReport	This class formats a single target in a standard format.
class	TextReport	This simple report displays static HTML text.
class	TreeReport	This class creates a hierarchical list of reports (reports sorted within folders) that is used by the 'Navigator' feature of the Patchworks web based reports.

Methods in ca.spatial.reportwriter that return Report

Modifier and Type	Method	Description
Report	Report.addDefaultParam(String key, Object value)	Add a parameter to the list of defaults.
Report	ReportWriter.addReport(Report r)	Add a report definition to the ReportWriter catalog.
Report	ReportWriter.knownReport(String reportName)	Test if a document is known by the reportWriter.
Report	Report.setDefaultParams(String[][] defaults)	Set a list of parameters that will be used with this report.
Report	Report.setDisplayFormat(String pattern)
Report	Report.setIndexed(boolean indexed)	Set a flag to indicate that the report is indexed or not.
Report	Report.setSelected(boolean selected)	Set a flag to indicate if the report is selected or not.
Report	Report.setTitle(String title)	A function to set the report title

Methods in ca.spatial.reportwriter that return types with arguments of type Report

Modifier and Type	Method	Description
ArrayList<Report>	ReportWriter.getHandlers()	Get the default handlers
Map<String,Report>	ReportWriter.getHiddenReports()
HashMap<String,Report>	ReportWriter.getReportList()	Retrieve a hashmap listing all documents visible to this report writer.
Map<String,Report>	ReportWriter.getReports()	Get the reports hashtable

Methods in ca.spatial.reportwriter with parameters of type Report

Modifier and Type	Method	Description
void	ReportWriter.addHiddenReport(Report r)	Add a report definition that will not be exposed to the ReportWriter catalog.
Report	ReportWriter.addReport(Report r)	Add a report definition to the ReportWriter catalog.
MapLayoutReport.ReportChart	MapLayoutReport.Group.addReportChart(double x, double y, double width, double height, Report report)	Add a report chart.
MapLayoutReport.ReportChart	MapLayoutReport.Group.addReportChart(double x, double y, double width, double height, String label, Report report)	Add a report chart
MapLayoutReport.ReportTable	MapLayoutReport.Group.addReportTable(double x, double y, double width, double height, Report report)	Add a report table.
MapLayoutReport.ReportTable	MapLayoutReport.Group.addReportTable(double x, double y, double width, double height, String label, Report report)	Add a report table.
int	ReportWriter.compare(Report o1, Report o2)	Comparator interface to sort dhandler names in order of decreasing length of name.
int	Report.compareTo(Report r2)
boolean	ReportWriter.containsReport(Report r)	Test if this reportWriter container contains the report object.
WizardPane	BoxAndWhiskerChartReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	CategoryCategoryReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	CategoryExpressionReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	CategoryPatternReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	CategoryReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	ColumnSummaryReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Every report that support configuration via a wizard must override this class.
WizardPane	CompareReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	IndexReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	MapReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	PeriodCategoryReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	PeriodExpressionReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	PeriodPatternReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	PeriodValueReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Every report that support configuration via a wizard must override this class.
WizardPane	PivotTableReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	RangePeriodReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	RasterRemapReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Every report that support configuration via a wizard must override this class.
abstract WizardPane	ReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Return a chain of WizardPane's that obtain report configuration information.
WizardPane	StandardReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Every report that support configuration via a wizard must override this class.
WizardPane	TableQueryReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	TargetLimitReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Every report that support configuration via a wizard must override this class.
WizardPane	TargetReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
WizardPane	TargetStatusReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)	Every report that support configuration via a wizard must override this class.
WizardPane	TextReportConfigurator.getConfigurator(Wizard wiz, ReportWriter rw, Report report)
static WizardPane	ReportConfigurator.getNameAndTitle(Wizard wiz, ReportWriter rw, Report report)	Return a panel that prompts for the report title and name.
void	ReportWriter.updateNode(Report r)

Constructors in ca.spatial.reportwriter with parameters of type Report

Modifier	Constructor	Description
	AddReportWizard(Frame parent, ReportWriter rw, String folder, Report report)

Constructor parameters in ca.spatial.reportwriter with type arguments of type Report

Modifier	Constructor	Description
	IndexReport(String filename, String title, String text, Map<String,Report> reports)	Deprecated.