public class

PieChartResource

extends SearchQueryBackedResource
java.lang.Object
   ↳ com.atlassian.jira.gadgets.system.AbstractResource
     ↳ com.atlassian.jira.gadgets.system.SearchQueryBackedResource
       ↳ com.atlassian.jira.gadgets.system.PieChartResource

Class Overview

REST endpoint to validate and retreive Pie chart.

Summary

Nested Classes
class PieChartResource.DataRow  
class PieChartResource.PieChart A simple bean contain all information required to render the Pie Chart  
[Expand]
Inherited Constants
From class com.atlassian.jira.gadgets.system.SearchQueryBackedResource
[Expand]
Inherited Fields
From class com.atlassian.jira.gadgets.system.SearchQueryBackedResource
Public Constructors
PieChartResource(ChartFactory chartFactory, ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, StatisticTypesResource statisticTypesResource, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory)
Public Methods
Response getPieChart(String queryString, String statType, boolean returnData, int width, int height)
Generate a pie chart and returns a simple bean containing all relievent information
Response validatePieChart(String queryString, String statType)
Ensures all parameters are valid for the Pie Chart
[Expand]
Inherited Methods
From class com.atlassian.jira.gadgets.system.SearchQueryBackedResource
From class com.atlassian.jira.gadgets.system.AbstractResource
From class java.lang.Object

Public Constructors

public PieChartResource (ChartFactory chartFactory, ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, StatisticTypesResource statisticTypesResource, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory)

Public Methods

public Response getPieChart (String queryString, String statType, boolean returnData, int width, int height)

Generate a pie chart and returns a simple bean containing all relievent information

Parameters
queryString a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
statType a valid statistic type. See StatisticTypesResource
returnData whther or not to return the data
width the width of the chart in pixels (defaults to 400px)
height the height of the chart in pixels (defaults to 250px)
Returns
  • a PieChartResource.PieChart if all params validated else a Collection of com.atlassian.jira.rest.v1.model.errors.ValidationError

public Response validatePieChart (String queryString, String statType)

Ensures all parameters are valid for the Pie Chart

Parameters
queryString a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
statType a valid statistic type. See StatisticTypesResource
Returns
  • a Collection of com.atlassian.jira.rest.v1.model.errors.ValidationError. Or empty list if no errors.