io.jenkins.plugins.metrics.view

Class MetricsView

java.lang.Object

io.jenkins.plugins.datatables.DefaultAsyncTableContentProvider

io.jenkins.plugins.metrics.view.MetricsView

All Implemented Interfaces:

hudson.model.ModelObject, io.jenkins.plugins.datatables.AsyncTableContentProvider

@ExportedBean
public class MetricsView
extends io.jenkins.plugins.datatables.DefaultAsyncTableContentProvider
implements hudson.model.ModelObject

Build view for displaying metrics.

Author:

Andreas Pabst

Constructor Summary

Constructors

Constructor and Description
MetricsView(hudson.model.Run<?,?> owner) Create a new MetricsView.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
Object	getDynamic(String link, org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Returns the ClassDetailsView for the selected class.
String	getHistogram(String metricId) Get the histogram for a specific metric.
String	getMetricsJSON() Get all metrics for the table as JSON.
String	getMetricsTree(String metricId) Get a tree consisting of MetricsTreeNodes for a specific metric.
hudson.model.Run<?,?>	getOwner() Returns the build as owner of this object.
List<String>	getProjectOverview()
String	getScatterPlot(String metricId, String secondMetricId) Get a scatterplot for two metrics.
List<MetricDefinition>	getSupportedMetrics()
String	getSupportedMetricsJSON()
io.jenkins.plugins.datatables.TableModel	getTableModel(String id) Get the table model for the metrics details table.

Methods inherited from class io.jenkins.plugins.datatables.DefaultAsyncTableContentProvider

getTableRows

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsView

public MetricsView(hudson.model.Run<?,?> owner)

Create a new MetricsView.

Parameters:

owner - the Run owning the view

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

getOwner

public final hudson.model.Run<?,?> getOwner()

Returns the build as owner of this object.

Returns:

the owner

getSupportedMetrics

@JavaScriptMethod
public List<MetricDefinition> getSupportedMetrics()

getSupportedMetricsJSON

public String getSupportedMetricsJSON()

getProjectOverview

public List<String> getProjectOverview()

getMetricsJSON

@JavaScriptMethod
public String getMetricsJSON()

Get all metrics for the table as JSON.

Returns:

the JSON string

getMetricsTree

@JavaScriptMethod
public String getMetricsTree(String metricId)

Get a tree consisting of MetricsTreeNodes for a specific metric.

Parameters:

metricId - the id of the metric to show

Returns:

a string containing the tree's JSON

getHistogram

@JavaScriptMethod
public String getHistogram(String metricId)

Get the histogram for a specific metric.

Parameters:

metricId - the id of the metric to show

Returns:

the contents of the histogram as JSON

getScatterPlot

@JavaScriptMethod
public String getScatterPlot(String metricId,
                                               String secondMetricId)

Get a scatterplot for two metrics.

Parameters:

metricId - the id of the first metric to include

secondMetricId - the id of the second metric to include

Returns:

the contens of the scatter plot as JSON

getDynamic

public Object getDynamic(String link,
                         org.kohsuke.stapler.StaplerRequest request,
                         org.kohsuke.stapler.StaplerResponse response)

Returns the ClassDetailsView for the selected class.

Parameters:

link - the name of the class to show details for

request - Stapler request

response - Stapler response

Returns:

the new class details view

getTableModel

public io.jenkins.plugins.datatables.TableModel getTableModel(String id)

Get the table model for the metrics details table.

Specified by:

getTableModel in interface io.jenkins.plugins.datatables.AsyncTableContentProvider

Parameters:

id - the id of the table to retrieve

Returns:

the MetricsTableModel containing all metrics