Package ca.spatial.patchworks

Class ScenarioEventReport

java.lang.Object

ca.spatial.reportwriter.Report

ca.spatial.patchworks.ScenarioEventReport

All Implemented Interfaces:

EventLogger, Selectable<Report>, Comparable<Report>, Observer

public class ScenarioEventReport
extends Report
implements EventLogger, Observer

This report logs significant events in the life cycle of a Patchworks simulation run.

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	CANCEL_TREATMENTS
static String	CHANGE_TREATMENT
static String	DIGEST
static String	INITIALIZED
static String	LOAD_FILE
static String	SCHEDULING
static String	SET_RANDOM
static String	TARGET_CHANGED
static String[]	TYPES
static String	USER_EVENT

Fields inherited from class ca.spatial.reportwriter.Report

AREA, LINE, PIE, SIDE_BY_SIDE_BARS, STACKED_BARS

Constructor Summary

Constructors

Constructor	Description
ScenarioEventReport(String filename, String title, Control control)

Method Summary

Modifier and Type	Method	Description
void	addNote(String note)
void	addNote(String event, String note)
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.
Control	getControl()
String[]	getTypes()	An accessor function to retrieve the list of report types supported by this report.
void	logEvent(String event, String detail)	Add an event to the logger
void	update(Observable o, Object args)

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

USER_EVENT

public static final String USER_EVENT

See Also:

Constant Field Values

LOAD_FILE

public static final String LOAD_FILE

See Also:

Constant Field Values

DIGEST

public static final String DIGEST

See Also:

Constant Field Values

SET_RANDOM

public static final String SET_RANDOM

See Also:

Constant Field Values

INITIALIZED

public static final String INITIALIZED

See Also:

Constant Field Values

SCHEDULING

public static final String SCHEDULING

See Also:

Constant Field Values

CHANGE_TREATMENT

public static final String CHANGE_TREATMENT

See Also:

Constant Field Values

CANCEL_TREATMENTS

public static final String CANCEL_TREATMENTS

See Also:

Constant Field Values

TARGET_CHANGED

public static final String TARGET_CHANGED

See Also:

Constant Field Values

Constructor Details

ScenarioEventReport

public ScenarioEventReport(String filename,
 String title,
 Control control)

Method Details

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

logEvent

public void logEvent(String event,
 String detail)

Description copied from interface: EventLogger

Add an event to the logger

Specified by:

logEvent in interface EventLogger

getControl

public Control getControl()

update

public void update(Observable o,
 Object args)

Specified by:

update in interface Observer

addNote

public void addNote(String note)

addNote

public void addNote(String event,
 String note)