Package io.jenkins.plugins.analysis.core.portlets

Class IssuesTablePortlet

java.lang.Object

hudson.plugins.view.dashboard.DashboardPortlet

io.jenkins.plugins.analysis.core.portlets.IssuesTablePortlet

All Implemented Interfaces:

ExtensionPoint, Describable<hudson.plugins.view.dashboard.DashboardPortlet>, ModelObject

public class IssuesTablePortlet
extends hudson.plugins.view.dashboard.DashboardPortlet

A dashboard view portlet that renders a two-dimensional table of issues per type and job.

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IssuesTablePortlet.Column	Properties of a column in the table.
static class	IssuesTablePortlet.IssuesTablePortletDescriptor	Extension point registration.
static class	IssuesTablePortlet.PortletTableModel	Provides the model for the two-dimensional table of issues per type and job.
static class	IssuesTablePortlet.Result	Provides the model for a cell of the table, that contains the static analysis result.
static class	IssuesTablePortlet.TableRow	Provides the model for a row of the table.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
IssuesTablePortlet(String name)	Creates a new instance of IssuesTablePortlet.

Method Summary

Modifier and Type	Method	Description
boolean	getHideCleanJobs()
IssuesTablePortlet.PortletTableModel	getModel(List<Job<?,?>> jobs)	Returns a model for the table with the results per job.
boolean	getSelectTools()
boolean	getShowIcons()
List<ToolSelection>	getTools()
void	setHideCleanJobs(boolean hideCleanJobs)	Determines if all jobs that have no issues from the selected static analysis tools should be hidden.
void	setSelectTools(boolean selectTools)	Determines whether all available tools should be selected or if the selection should be done individually.
void	setShowIcons(boolean showIcons)	Determines if the table column headers should show icons or text.
void	setTools(List<ToolSelection> tools)	Returns the tools that should be taken into account when summing up the totals of a job.

Methods inherited from class hudson.plugins.view.dashboard.DashboardPortlet

all, getComparator, getDashboard, getDescriptor, getDisplayName, getId, getJob, getName, getUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuesTablePortlet

@DataBoundConstructor
public IssuesTablePortlet(String name)

Creates a new instance of IssuesTablePortlet.

Parameters:

name - the name of the portlet

Method Detail

getHideCleanJobs

public boolean getHideCleanJobs()

setHideCleanJobs

@DataBoundSetter
public void setHideCleanJobs(boolean hideCleanJobs)

Determines if all jobs that have no issues from the selected static analysis tools should be hidden.

Parameters:

hideCleanJobs - if true then all jobs with no issues will be hidden, false otherwise

getShowIcons

public boolean getShowIcons()

setShowIcons

@DataBoundSetter
public void setShowIcons(boolean showIcons)

Determines if the table column headers should show icons or text.

Parameters:

showIcons - if true the table column headers will show the tool icon, otherwise the name of the tool is shown

getSelectTools

public boolean getSelectTools()

setSelectTools

@DataBoundSetter
public void setSelectTools(boolean selectTools)

Determines whether all available tools should be selected or if the selection should be done individually.

Parameters:

selectTools - if true the selection of tools can be done manually by selecting the corresponding ID, otherwise all available tools in a job are automatically selected

getTools

public List<ToolSelection> getTools()

setTools

@DataBoundSetter
public void setTools(List<ToolSelection> tools)

Returns the tools that should be taken into account when summing up the totals of a job.

Parameters:

tools - the tools to select

See Also:

setSelectTools(boolean)

getModel

public IssuesTablePortlet.PortletTableModel getModel(List<Job<?,?>> jobs)

Returns a model for the table with the results per job.

Parameters:

jobs - the jobs that will be rendered in the rows

Returns:

the table model