Package hudson.plugins.plot

Class Series

java.lang.Object

hudson.model.AbstractDescribableImpl<Series>

hudson.plugins.plot.Series

All Implemented Interfaces:

Describable<Series>

Direct Known Subclasses:

CSVSeries, PropertiesSeries, XMLSeries

public abstract class Series
extends AbstractDescribableImpl<Series>

Represents a plot data series configuration.

Author:

Nigel Daley, Allen Reese

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Series.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected String	file	Relative path to the data series property file.
protected String	fileType	Data series type.
protected String	label	Data series legend label.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Series(String file, String label, String fileType)

Method Summary

Modifier and Type	Method	Description
Descriptor<Series>	getDescriptor()
String	getFile()
String	getFileType()
String	getLabel()
protected String	getUrl(String baseUrl, String label, int index, int buildNumber)	Return the url that should be used for this point.
abstract List<PlotPoint>	loadSeries(FilePath workspaceRootDir, int buildNumber, PrintStream logger)	Retrieves the plot data for one series after a build from the workspace.

Methods inherited from class java.lang.Object

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

Field Detail

file

protected String file

Relative path to the data series property file. Mandatory.

label

protected String label

Data series legend label. Optional.

fileType

protected String fileType

Data series type. Mandatory. This can be csv, xml, or properties file. This should be an enum, but I am not sure how to support that with stapler at the moment

Constructor Detail

Series

protected Series(String file,
                 String label,
                 String fileType)

Method Detail

getFile

public String getFile()

getLabel

public String getLabel()

getFileType

public String getFileType()

loadSeries

public abstract List<PlotPoint> loadSeries(FilePath workspaceRootDir,
                                           int buildNumber,
                                           PrintStream logger)

Retrieves the plot data for one series after a build from the workspace.

Parameters:

workspaceRootDir - the root directory of the workspace

buildNumber - the build Number

logger - the logger to use

Returns:

a PlotPoint array of points to plot

getUrl

protected String getUrl(String baseUrl,
                        String label,
                        int index,
                        int buildNumber)

Return the url that should be used for this point.

Parameters:

label - Name of the column

index - Index of the column

buildNumber - The build number

Returns:

url for the label.

getDescriptor

public Descriptor<Series> getDescriptor()

Specified by:

getDescriptor in interface Describable<Series>

Overrides:

getDescriptor in class AbstractDescribableImpl<Series>