ca.utoronto.JCVSReport.report
Class Report

java.lang.Object
  ca.utoronto.JCVSReport.report.Report

public class Report

extends Object

Write a set of graphs out to an HTML file

Author:

David James

Constructor Summary

Report(MetricDatabase database)
Initialize a new Report object

Method Summary

void	addGraph(String graphName) Add a graph to this report
void	addGraphs(String[] graphNames) Add in a set of graphs
Graph[]	getGraphs() Get a list of the graphs
void	processRevision(String revisionId, String contents) Process the contents of a revision of a file with each metric
void	write(PrintWriter output, File directory) Write reports to an output directory
void	write(String output, String directory) Write reports to an output directory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Report

public Report(MetricDatabase database)

Initialize a new Report object

Parameters:

database - Where to get our statistics

Method Detail

addGraph

public void addGraph(String graphName)
              throws Exception

Add a graph to this report

Parameters:

graphName - The name of the graph we want to add

Throws:

Exception

addGraphs

public void addGraphs(String[] graphNames)
               throws Exception

Add in a set of graphs

Parameters:

graphNames - The names of the graphs we want to add

Throws:

Exception

write

public void write(String output,
                  String directory)
           throws Exception

Write reports to an output directory

Parameters:

output - Where to write the HTML report

directory - Where to store images

Throws:

Exception

write

public void write(PrintWriter output,
                  File directory)
           throws Exception

Write reports to an output directory

Parameters:

output - Where to write the HTML report

directory - Where to store images

Throws:

Exception

processRevision

public void processRevision(String revisionId,
                            String contents)
                     throws Exception

Process the contents of a revision of a file with each metric

Parameters:

revisionId - A unique ID for this revision of this file

contents - The contents of the file as a string

Throws:

Exception - if this revision cannot be processed

getGraphs

public Graph[] getGraphs()

Get a list of the graphs