org.perfcake.reporting.destination.c3chart

Class C3ChartData

java.lang.Object

org.perfcake.reporting.destination.c3chart.C3ChartData

public class C3ChartData
extends Object

Data of a C3 chart stored in the .js file as a script building an array. Does not work with the data header and does not know anything about the actual data. It is the role of C3Chart to carry all the meta-data.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
C3ChartData(String baseName, Path target) Reads the chart data from the appropriate data file.

Method Summary

Modifier and Type	Method and Description
C3ChartData	filter(int keepColumnIndex) Creates a new chart where with only two columns from the original chart.
List<io.vertx.core.json.JsonArray>	getData() Gets the data lines.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

C3ChartData

public C3ChartData(String baseName,
                   Path target)
            throws PerfCakeException

Reads the chart data from the appropriate data file. The data file is located in ${target}/data/${baseName}.js.

Parameters:

baseName - The base of the chart data files name.

target - The target path where the chart report is stored. The individual data files are located in ${target}/data/${baseName}.js.

Throws:

PerfCakeException - When there was an error reading the data. Mainly because of some I/O error.

Method Detail

filter

public C3ChartData filter(int keepColumnIndex)

Creates a new chart where with only two columns from the original chart. These columns have indexes 0 and the second is specified in the parameter. This is used to create a subchart with the values of the X axis and one data line.

Parameters:

keepColumnIndex - The index of the column to be kept.

Returns:

A new chart where with only two columns - the X axis values and the data line specified in the parameter.

getData

public List<io.vertx.core.json.JsonArray> getData()

Gets the data lines.

Returns:

The data lines.

toString

public String toString()

Overrides:

toString in class Object