hudson.plugins.plot
Class Series

java.lang.Object
  hudson.plugins.plot.Series

Direct Known Subclasses:

CSVSeries, PropertiesSeries, XMLSeries

public abstract class Series
extends Object

Represents a plot data series configuration.

Author:

Nigel Daley, Allen Reese

Field Summary

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

protected

Series(String file, String label, String fileType)

Method Summary

String	getFile()
String	getFileType()
String	getLabel()
abstract List<PlotPoint>	loadSeries(hudson.FilePath workspaceRootDir, 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(hudson.FilePath workspaceRootDir,
                                           PrintStream logger)

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

Parameters:

workspaceRootDir - the root directory of the workspace

logger - the logger to use

Returns:

a PlotPoint array of points to plot