io.jenkins.plugins.echarts.api.charts

Class SeriesBuilder<T>

java.lang.Object

io.jenkins.plugins.echarts.api.charts.SeriesBuilder<T>

Type Parameters:

T - type of the result

public abstract class SeriesBuilder<T>
extends Object

Provides the base algorithms to create a data set for a static analysis graph. The actual series for each result needs to be implemented by sub classes in method computeSeries(T).

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor and Description
SeriesBuilder() Creates a new SeriesBuilder.

Method Summary

Modifier and Type	Method and Description
protected abstract Map<String,Integer>	computeSeries(T current) Returns the series to plot for the specified build result.
LinesDataSet	createAggregatedDataSet(ChartModelConfiguration configuration, List<Iterable<? extends BuildResult<T>>> results) Creates a new data set for a category graph from the specified static analysis results.
LinesDataSet	createDataSet(ChartModelConfiguration configuration, Iterable<? extends BuildResult<T>> results) Creates a new data set for a category graph from the specified static analysis results.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesBuilder

public SeriesBuilder()

Creates a new SeriesBuilder.

Method Detail

createAggregatedDataSet

public LinesDataSet createAggregatedDataSet(ChartModelConfiguration configuration,
                                            List<Iterable<? extends BuildResult<T>>> results)

Creates a new data set for a category graph from the specified static analysis results. The list of results (each one provided by an iterator) must be sorted by build number in descending order. I.e., the iterator starts with the newest build and stops at the oldest build. The actual series for each result needs to be implemented by sub classes by overriding method computeSeries(T).

Parameters:

configuration - configures the data set (how many results should be process, etc.)

results - the ordered static analysis results

Returns:

the created data set

createDataSet

public LinesDataSet createDataSet(ChartModelConfiguration configuration,
                                  Iterable<? extends BuildResult<T>> results)

Creates a new data set for a category graph from the specified static analysis results. The results (provided by an iterator) must be sorted by build number in descending order. I.e., the iterator starts with the newest build and stops at the oldest build. The actual series for each result needs to be implemented by sub classes by overriding method computeSeries(T).

Parameters:

configuration - configures the data set (how many results should be process, etc.)

results - the ordered static analysis results

Returns:

the created data set

computeSeries

protected abstract Map<String,Integer> computeSeries(T current)

Returns the series to plot for the specified build result.

Parameters:

current - the result of the current build for which the series should be computed

Returns:

the series to plot