org.perfcake.reporting.destination

Class ChartDestination

java.lang.Object

org.perfcake.reporting.destination.AbstractDestination

org.perfcake.reporting.destination.ChartDestination

All Implemented Interfaces:

Closeable, AutoCloseable, Destination

public class ChartDestination
extends AbstractDestination

Creates nice charts from the results. The charts are generated to the outputPath path. The charts in the same group can be later combined together based on the names of the columns. All previously generated charts in the outputPath path are placed in the final report. Use with caution as the big number of results can take too long to load in the browser. Each chart has a quick view file where the results can be seen while the test is still running.

Author:

Martin Večeřa

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartDestination.ChartType

Constructor Summary

Constructors

Constructor and Description
ChartDestination()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the destination.
String	getAttributes() Gets the attributes that will be written to the chart.
List<String>	getAttributesAsList() Gets the attributes that will be written to the chart as a List.
String	getGroup() Gets the group of the resulting chart.
int	getChartHeight() Gets the height of the resulting chart in pixels.
String	getName() Gets the name of the chart.
String	getOutputDir() Gets the output directory for charts.
Path	getOutputDirAsPath() Gets the output directory for charts as the Path data type.
ChartDestination.ChartType	getType() Gets the chart's graphics type - either line or bar.
String	getxAxis() Gets the legend of the X axis of the chart.
String	getXAxis() Gets the legend of the X axis of the chart.
PeriodType	getxAxisType() Gets the type of the X axis.
String	getyAxis() Gets the legend of the Y axis of the chart.
String	getYAxis() Gets the legend of the Y axis of the chart.
boolean	isAutoCombine() Should we automatically combine previous chart reports with the new one?
void	open() Opens the destination for reporting.
void	report(Measurement measurement) Reports a new Measurement to the destination.
ChartDestination	setAttributes(String attributes) Sets the attributes that will be written to the chart.
ChartDestination	setAutoCombine(boolean autoCombine) Should we automatically combine previous chart reports with the new one?
ChartDestination	setGroup(String group) Sets the group of the resulting chart.
ChartDestination	setChartHeight(int chartHeight) Sets the height of the resulting chart in pixels.
ChartDestination	setName(String name) Sets the name of the chart.
ChartDestination	setOutputDir(String outputDir) Sets the output directory for charts.
ChartDestination	setType(ChartDestination.ChartType type) Sets the chart's graphics type - either line or bar.
ChartDestination	setxAxis(String xAxis) Sets the legend of the X axis of the chart.
ChartDestination	setXAxis(String xAxis) Sets the legend of the X axis of the chart.
ChartDestination	setxAxisType(PeriodType xAxisType) Sets the type of the X axis.
ChartDestination	setyAxis(String yAxis) Sets the legend of the Y axis of the chart.
ChartDestination	setYAxis(String yAxis) Sets the legend of the Y axis of the chart.

Methods inherited from class org.perfcake.reporting.destination.AbstractDestination

getParentReporter, open

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartDestination

public ChartDestination()

Method Detail

open

public void open()

Description copied from class: AbstractDestination

Opens the destination for reporting.

Specified by:

open in class AbstractDestination

close

public void close()

Description copied from interface: Destination

Closes the destination. No other value should be reported after that.

report

public void report(Measurement measurement)
            throws ReportingException

Description copied from interface: Destination

Reports a new Measurement to the destination.

Parameters:

measurement - A measurement to be reported.

Throws:

ReportingException - When an error occurred during reporting the measurement like no space left on device. The root cause should be encapsulated.

getOutputDir

public String getOutputDir()

Gets the output directory for charts.

Returns:

The output directory location.

setOutputDir

public ChartDestination setOutputDir(String outputDir)

Sets the output directory for charts.

Parameters:

outputDir - The output directory location.

Returns:

Instance of this to support fluent API.

getOutputDirAsPath

public Path getOutputDirAsPath()

Gets the output directory for charts as the Path data type.

Returns:

The output directory location.

getName

public String getName()

Gets the name of the chart.

Returns:

The name of the chart.

setName

public ChartDestination setName(String name)

Sets the name of the chart.

Parameters:

name - The name of the chart.

Returns:

Instance of this to support fluent API.

getGroup

public String getGroup()

Gets the group of the resulting chart.

Returns:

The group of the chart.

setGroup

public ChartDestination setGroup(String group)

Sets the group of the resulting chart.

Parameters:

group - The group of the chart.

Returns:

Instance of this to support fluent API.

getChartHeight

public int getChartHeight()

Gets the height of the resulting chart in pixels.

Returns:

The height of the resulting chart in pixels.

setChartHeight

public ChartDestination setChartHeight(int chartHeight)

Sets the height of the resulting chart in pixels.

Parameters:

chartHeight - The height of the resulting chart in pixels.

Returns:

The height of the resulting chart in pixels.

getyAxis

public String getyAxis()

Gets the legend of the Y axis of the chart.

Returns:

The legend of the Y axis of the chart.

getYAxis

public String getYAxis()

Gets the legend of the Y axis of the chart.

Returns:

The legend of the Y axis of the chart.

setyAxis

public ChartDestination setyAxis(String yAxis)

Sets the legend of the Y axis of the chart.

Parameters:

yAxis - The legend of the Y axis of the chart.

Returns:

Instance of this to support fluent API.

setYAxis

public ChartDestination setYAxis(String yAxis)

Sets the legend of the Y axis of the chart.

Parameters:

yAxis - The legend of the Y axis of the chart.

Returns:

Instance of this to support fluent API.

getxAxis

public String getxAxis()

Gets the legend of the X axis of the chart.

Returns:

The legend of the X axis of the chart.

getXAxis

public String getXAxis()

Gets the legend of the X axis of the chart.

Returns:

The legend of the X axis of the chart.

setxAxis

public ChartDestination setxAxis(String xAxis)

Sets the legend of the X axis of the chart.

Parameters:

xAxis - The legend of the X axis of the chart.

Returns:

Instance of this to support fluent API.

setXAxis

public ChartDestination setXAxis(String xAxis)

Sets the legend of the X axis of the chart.

Parameters:

xAxis - The legend of the X axis of the chart.

Returns:

Instance of this to support fluent API.

getxAxisType

public PeriodType getxAxisType()

Gets the type of the X axis. It can be either Time, Percents, or Iteration number.

Returns:

The type of the X axis.

setxAxisType

public ChartDestination setxAxisType(PeriodType xAxisType)

Sets the type of the X axis. It can be either Time, Percents, or Iteration number.

Parameters:

xAxisType - The type of the X axis.

Returns:

Instance of this to support fluent API.

getAttributes

public String getAttributes()

Gets the attributes that will be written to the chart.

Returns:

The attributes separated by comma.

setAttributes

public ChartDestination setAttributes(String attributes)

Sets the attributes that will be written to the chart.

Parameters:

attributes - The attributes separated by comma.

Returns:

Instance of this to support fluent API.

getAttributesAsList

public List<String> getAttributesAsList()

Gets the attributes that will be written to the chart as a List.

Returns:

The attributes list.

isAutoCombine

public boolean isAutoCombine()

Should we automatically combine previous chart reports with the new one?

Returns:

True if and only if the combining feature is turned on.

setAutoCombine

public ChartDestination setAutoCombine(boolean autoCombine)

Should we automatically combine previous chart reports with the new one?

Parameters:

autoCombine - True to turn the feature on, false to turn it off. Default is true/on.

Returns:

Instance of this to support fluent API.

getType

public ChartDestination.ChartType getType()

Gets the chart's graphics type - either line or bar. Line is the default.

Returns:

The chart's graphics type.

setType

public ChartDestination setType(ChartDestination.ChartType type)

Sets the chart's graphics type - either line or bar. Line is the default.

Parameters:

type - The chart's graphics type.

Returns:

Instance of this to support fluent API.