io.jenkins.plugins.forensics.miner

Class FilesCountTrendChart

java.lang.Object

io.jenkins.plugins.forensics.miner.FilesCountTrendChart

public class FilesCountTrendChart
extends Object

Builds the Java side model for a trend chart showing the number of files in the repository. The trend chart contains one series that shows the number of files per build. The number of builds to consider is controlled by a ChartModelConfiguration instance. The created model object can be serialized to JSON (e.g., using the JacksonFacade) and can be used 1:1 as ECharts configuration object in the corresponding JS file.

Author:

Ullrich Hafner

See Also:

JacksonFacade

Constructor Summary

Constructors

Constructor and Description
FilesCountTrendChart()

Method Summary

Modifier and Type	Method and Description
edu.hm.hafner.echarts.LinesChartModel	create(Iterable<? extends edu.hm.hafner.echarts.BuildResult<ForensicsBuildAction>> results, edu.hm.hafner.echarts.ChartModelConfiguration configuration) Creates the chart for the specified results.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesCountTrendChart

public FilesCountTrendChart()

Method Detail

create

public edu.hm.hafner.echarts.LinesChartModel create(Iterable<? extends edu.hm.hafner.echarts.BuildResult<ForensicsBuildAction>> results,
                                                    edu.hm.hafner.echarts.ChartModelConfiguration configuration)

Creates the chart for the specified results.

Parameters:

results - the forensics results to render - these results must be provided in descending order, i.e. the current build is the head of the list, then the previous builds, and so on

configuration - the chart configuration to be used

Returns:

the chart model, ready to be serialized to JSON