Package com.atlassian.jira.gadgets.system

Class PieChartResource

java.lang.Object

com.atlassian.jira.gadgets.system.AbstractResource

com.atlassian.jira.gadgets.system.SearchQueryBackedResource

com.atlassian.jira.gadgets.system.PieChartResource

@Path("piechart")
@Produces("application/json")
public class PieChartResource
extends SearchQueryBackedResource

REST endpoint to validate and retreive Pie chart.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PieChartResource.DataRow
static class	PieChartResource.PieChart	A simple bean contain all information required to render the Pie Chart

Field Summary

Fields inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource

QUERY_STRING, searchService

Constructor Summary

Constructors

Constructor	Description
PieChartResource(ChartFactory chartFactory, ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, StatisticTypesProvider statisticTypesProvider, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getPieChart(String queryString, String statType, boolean returnData, int width, int height, boolean inline)	Generate a pie chart and returns a simple bean containing all relievent information
jakarta.ws.rs.core.Response	validatePieChart(String queryString, String statType)	Ensures all parameters are valid for the Pie Chart

Methods inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource

getFilterTitle, getFilterUrl, getSearchRequestAndValidate, validateSize

Methods inherited from class com.atlassian.jira.gadgets.system.AbstractResource

createErrorResponse, createIndexingUnavailableResponse, createServerErroreResponse, createValidationResponse

Methods inherited from class java.lang.Object

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

Constructor Details

PieChartResource

@Inject
public PieChartResource(ChartFactory chartFactory,
 ChartUtils chartUtils,
 JiraAuthenticationContext authenticationContext,
 PermissionManager permissionManager,
 StatisticTypesProvider statisticTypesProvider,
 SearchService searchService,
 VelocityRequestContextFactory velocityRequestContextFactory)

Method Details

getPieChart

@GET
@Path("/generate")
public jakarta.ws.rs.core.Response getPieChart(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("statType") @DefaultValue("assignees")
 String statType,
 @QueryParam("returnData") @DefaultValue("false")
 boolean returnData,
 @QueryParam("width") @DefaultValue("400")
 int width,
 @QueryParam("height") @DefaultValue("250")
 int height,
 @QueryParam("inline") @DefaultValue("false")
 boolean inline)

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 - determines whether 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 ValidationError

validatePieChart

@GET
@Path("validate")
public jakarta.ws.rs.core.Response validatePieChart(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("statType")
 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 ValidationError. Or empty list if no errors.