org.perfcake.reporting.destination.c3chart

Class C3ChartHelper

java.lang.Object

org.perfcake.reporting.destination.c3chart.C3ChartHelper

public class C3ChartHelper
extends Object

Helper class for the ChartDestination. Bridges the destination methods to the corresponding actions of other classes in the package.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
C3ChartHelper(ChartDestination chartDestination) Creates a new helper for the given ChartDestination.

Method Summary

Modifier and Type	Method and Description
void	appendResult(Measurement measurement) Appends the results in the current Measurement to the main chart.
void	close() Closes the data files.
void	compileResults(boolean autoCombine) Creates the final result report compiling all the previous charts together.
boolean	isInitialized() Is the helper properly initialized?

Methods inherited from class java.lang.Object

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

Constructor Detail

C3ChartHelper

public C3ChartHelper(ChartDestination chartDestination)

Creates a new helper for the given ChartDestination.

Parameters:

chartDestination - The ChartDestination this helper is supposed to serve to.

Method Detail

appendResult

public void appendResult(Measurement measurement)
                  throws ReportingException

Appends the results in the current Measurement to the main chart.

Parameters:

measurement - The current measurement.

Throws:

ReportingException - When it was not possible to append the results.

isInitialized

public boolean isInitialized()

Is the helper properly initialized?

Returns:

True if and only if the helper was properly initialized.

close

public void close()
           throws PerfCakeException

Closes the data files.

Throws:

PerfCakeException - When it was not possible to smoothly finalize the data files.

compileResults

public void compileResults(boolean autoCombine)
                    throws PerfCakeException

Creates the final result report compiling all the previous charts together.

Parameters:

autoCombine - True if we should combine the new results with the previous reports.

Throws:

PerfCakeException - When there was an error creating the report. Typically an I/O issue.