public class ChartDestination extends AbstractDestination
Modifier and Type | Class and Description |
---|---|
static class |
ChartDestination.ChartType |
Constructor and Description |
---|
ChartDestination() |
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.
|
getParentReporter, open
public void open()
AbstractDestination
open
in class AbstractDestination
public void close()
Destination
public void report(Measurement measurement) throws ReportingException
Destination
Measurement
to the destination.measurement
- A measurement to be reported.ReportingException
- When an error occurred during reporting the measurement like no space left on device. The root cause should be encapsulated.public String getOutputDir()
public ChartDestination setOutputDir(String outputDir)
outputDir
- The output directory location.public Path getOutputDirAsPath()
public String getName()
public ChartDestination setName(String name)
name
- The name of the chart.public String getGroup()
public ChartDestination setGroup(String group)
group
- The group of the chart.public int getChartHeight()
public ChartDestination setChartHeight(int chartHeight)
chartHeight
- The height of the resulting chart in pixels.public String getyAxis()
public String getYAxis()
public ChartDestination setyAxis(String yAxis)
yAxis
- The legend of the Y axis of the chart.public ChartDestination setYAxis(String yAxis)
yAxis
- The legend of the Y axis of the chart.public String getxAxis()
public String getXAxis()
public ChartDestination setxAxis(String xAxis)
xAxis
- The legend of the X axis of the chart.public ChartDestination setXAxis(String xAxis)
xAxis
- The legend of the X axis of the chart.public PeriodType getxAxisType()
public ChartDestination setxAxisType(PeriodType xAxisType)
xAxisType
- The type of the X axis.public String getAttributes()
public ChartDestination setAttributes(String attributes)
attributes
- The attributes separated by comma.public List<String> getAttributesAsList()
public boolean isAutoCombine()
public ChartDestination setAutoCombine(boolean autoCombine)
autoCombine
- True to turn the feature on, false to turn it off. Default is true/on.public ChartDestination.ChartType getType()
public ChartDestination setType(ChartDestination.ChartType type)
type
- The chart's graphics type.Copyright © 2010–2017 PerfCake Community. All rights reserved.