com.atlassian.clover.reporters.json

Class JSONHistoricalReporter

java.lang.Object

com.atlassian.clover.reporters.json.JSONHistoricalReporter

public class JSONHistoricalReporter
extends Object

Constructor Summary

Constructors

Constructor and Description
JSONHistoricalReporter(File basePath)

Method Summary

Modifier and Type	Method and Description
void	generateHistoricalJSON(clover.org.apache.velocity.VelocityContext context, Map<Long,HasMetrics> data, String title) Generates historical JSON data using a subset of the Google Visualisation DataSource response format.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONHistoricalReporter

public JSONHistoricalReporter(File basePath)

Method Detail

generateHistoricalJSON

public void generateHistoricalJSON(clover.org.apache.velocity.VelocityContext context,
                                   Map<Long,HasMetrics> data,
                                   String title)
                            throws Exception

Generates historical JSON data using a subset of the Google Visualisation DataSource response format.

Since Clover reports are only static, this will only contain the 'table' object, and does not contain the surrounding status etc. These extra fields could be added by a service which serves this file.

The basic format of the JSON produced is:

 table: {
      cols: [{id: 'timestamp', label: 'Date', type: 'date'}, ...],
      rows: [{c:[{v: new Date(0), f: '1 January 1970 00:00'}, ...]}]
 }
 

This data may be used directly with the google.visualization javascript Library. ie - the above JSON object may be passed directly to a google.visualization.DataTable constructor like so: new google.visualization.DataTable(json.table[0], 0.5);

e.g.

    var data = new google.visualization.DataTable(json.table[0], 0.5);
    var chart = new google.visualization.AreaChart(document.getElementById('chart_div'));
    chart.draw(data, {width: 800, height: 400, legend: 'bottom', title: 'Clover Historical Chart'});

Parameters:

context - the velocity context to use when rendering

data - the map of historical data points

Throws:

Exception - if an error occurs while writing the JSON