Package de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems

Class HistogramReportItem

java.lang.Object

de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractRReportItem

de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractPlotReportItem

de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.HistogramReportItem

All Implemented Interfaces:

IReportItem

public class HistogramReportItem
extends AbstractPlotReportItem

This report item displays a histogram.

Nested Class Summary

Nested classes/interfaces inherited from class de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractPlotReportItem

AbstractPlotReportItem.LegendPosition

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_NUMBER_CLASSES	Default number of classes.
static String	DEFAULT_X_AXIS_LABEL	Default label for the x axis.

Fields inherited from class de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractPlotReportItem

DEFAULT_FONT_SIZE, DEFAULT_GRAPHIC_SIZE, DEFAULT_LEGEND_POSITION

Fields inherited from class de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractRReportItem

DEFAULT_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
HistogramReportItem(String title, int height, int width, int fontSize, String xAxisLabel)	Constructs a new report item containing a histogram graphic.
HistogramReportItem(String title, String xAxisLabel)	Constructs a new report item containing a histogram graphic.

Method Summary

Modifier and Type	Method	Description
protected String	generatePlotCommand()	Overwrite this method to generate custom graphics.
int	getColumns()	Returns the number of classes of the histogram.
void	setColumns(int columns)	Set s the number of classes of the histogram.

Methods inherited from class de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractPlotReportItem

addData, generateColorsLegend, generateData, generateLinesLegend, generateRasterGraphic, generateVectorGraphic, getDataCommand, getDataSeries, getName, getTemporaryRasterGraphicFilename, getTemporaryVectorGraphicFilename, removeData, setLegendPos, visit

Methods inherited from class de.uka.ipd.sdq.sensorframework.visualisation.rvisualisation.reportitems.AbstractRReportItem

getDescription

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_X_AXIS_LABEL

public static final String DEFAULT_X_AXIS_LABEL

Default label for the x axis.

See Also:

Constant Field Values

DEFAULT_NUMBER_CLASSES

public static final int DEFAULT_NUMBER_CLASSES

Default number of classes.

See Also:

Constant Field Values

Constructor Detail

HistogramReportItem

public HistogramReportItem(String title,
                           String xAxisLabel)

Constructs a new report item containing a histogram graphic. The graphic is stored in a temporary file. This is accessible via the getFilename method.

Parameters:

title - Title of the plotted graphic.

xAxisLabel - Label for the x axis.

HistogramReportItem

public HistogramReportItem(String title,
                           int height,
                           int width,
                           int fontSize,
                           String xAxisLabel)

Constructs a new report item containing a histogram graphic. The graphic is stored in a temporary file. This is accessible via the getFilename method.

Parameters:

title - Title of the plotted graphic.

height - height of the plotted graphic.

width - width of the plotted graphics.

fontSize - the default pointsize of plotted text, interpreted at 72 dpi, so one point is approximately one pixel.

xAxisLabel - Label for the x axis.

Method Detail

generatePlotCommand

protected String generatePlotCommand()

Overwrite this method to generate custom graphics.

Specified by:

generatePlotCommand in class AbstractPlotReportItem

Returns:

The R command which execution leads to the creation of the plot.

getColumns

public int getColumns()

Returns the number of classes of the histogram.

Returns:

The number of classes.

setColumns

public void setColumns(int columns)

Set s the number of classes of the histogram.

Parameters:

columns - The number of classes.