org.perfcake.reporting.destination.c3chart

Class C3Chart

java.lang.Object

org.perfcake.reporting.destination.c3chart.C3Chart

public class C3Chart
extends Object

Represents a single C3 chart meta-data carrying all the information needed to represent the chart.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
C3Chart()

Method Summary

Modifier and Type	Method and Description
List<String>	getAttributes() Gets the attributes stored in the chart as a List.
String	getBaseName() Gets the base name of the data files of this chart.
long	getCreated() Gets the Unix timestamp of when this chart was created.
String	getGroup() Gets the group of the current chart.
int	getHeight() Gets the height of the resulting chart SVG graphics in pixels.
String	getName() Gets the name of the chart.
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.
PeriodType	getxAxisType() Gets the type of the X axis.
String	getyAxis() Gets the legend of the Y axis of the chart.
boolean	isCombined() Checks whether this chart was created as a combination of other existing charts.
void	setAttributes(List<String> attributes) Sets the attributes stored in the chart as a List.
void	setBaseName(String baseName) Sets the base of the file name of the chart file.
void	setCombined(boolean combined) Sets whether this chart was created as a combination of other existing charts.
void	setCreated(long created) Sets the Unix timestamp of when this chart was created.
void	setGroup(String group) Sets the group of the current chart.
void	setHeight(int height) Sets the height of the resulting chart SVG graphics in pixels.
void	setName(String name) Gets the name of the chart.
void	setType(ChartDestination.ChartType type) Sets the chart's graphics type - either line or bar.
void	setxAxis(String xAxis) Sets the legend of the X axis of the chart.
void	setxAxisType(PeriodType xAxisType) Gets the type of the X axis.
void	setyAxis(String yAxis) Sets the legend of the Y axis of the chart.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

C3Chart

public C3Chart()

Method Detail

getBaseName

public String getBaseName()

Gets the base name of the data files of this chart.

Returns:

The base name of the data files of this chart.

getName

public String getName()

Gets the name of the chart.

Returns:

The name 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.

getyAxis

public String getyAxis()

Gets the legend of the Y axis of the chart.

Returns:

The legend of the Y axis of the chart.

getAttributes

public List<String> getAttributes()

Gets the attributes stored in the chart as a List.

Returns:

The attributes list.

getGroup

public String getGroup()

Gets the group of the current chart.

Returns:

The group name of this chart.

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.

setBaseName

public void setBaseName(String baseName)

Sets the base of the file name of the chart file. E.g. from '/some/path/data/stats201501272232.js' it is just 'stats201501272232'.

Parameters:

baseName - The base of the file name of the chart file.

setName

public void setName(String name)

Gets the name of the chart.

Parameters:

name - The name of the chart.

setxAxis

public void setxAxis(String xAxis)

Sets the legend of the X axis of the chart.

Parameters:

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

setyAxis

public void setyAxis(String yAxis)

Sets the legend of the Y axis of the chart.

Parameters:

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

setxAxisType

public void setxAxisType(PeriodType xAxisType)

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

Parameters:

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

setAttributes

public void setAttributes(List<String> attributes)

Sets the attributes stored in the chart as a List.

Parameters:

attributes - The attributes stored in the chart as a List.

setGroup

public void setGroup(String group)

Sets the group of the current chart.

Parameters:

group - The group name of this chart.

isCombined

public boolean isCombined()

Checks whether this chart was created as a combination of other existing charts. Charts created as a combination of other charts do not have their object description and quick preview files generated.

Returns:

True if and only if this chart was created as a combination of other existing charts.

setCombined

public void setCombined(boolean combined)

Sets whether this chart was created as a combination of other existing charts. Charts created as a combination of other charts do not have their object description and quick preview files generated.

Parameters:

combined - True if and only if this chart was created as a combination of other existing charts.

getCreated

public long getCreated()

Gets the Unix timestamp of when this chart was created. Defaults to the class instantiation time.

Returns:

The Unix timestamp of when this chart was created.

setCreated

public void setCreated(long created)

Sets the Unix timestamp of when this chart was created.

Parameters:

created - The Unix timestamp of when this chart was created.

getHeight

public int getHeight()

Gets the height of the resulting chart SVG graphics in pixels.

Returns:

The height of the resulting chart SVG graphics in pixels.

setHeight

public void setHeight(int height)

Sets the height of the resulting chart SVG graphics in pixels.

Parameters:

height - The height of the resulting chart SVG graphics in pixels.

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 void 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.

toString

public String toString()

Overrides:

toString in class Object