Package com.atlassian.jira.gadgets.system

Class HeatMapResource

java.lang.Object

com.atlassian.jira.gadgets.system.AbstractResource

com.atlassian.jira.gadgets.system.SearchQueryBackedResource

com.atlassian.jira.gadgets.system.HeatMapResource

@Path("heatmap")
@Produces("application/json")
public class HeatMapResource
extends SearchQueryBackedResource

REST endpoint to validate and retreive a Heat Map. Similar to the pie chart gadget

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeatMapResource.DataRow
static class	HeatMapResource.HeatMap	A simple bean contain all information required to render the Heat Map

Field Summary

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

QUERY_STRING, searchService

Constructor Summary

Constructors

Constructor	Description
HeatMapResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, StatisticTypesProvider statisticTypesProvider, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory, CustomFieldManager customFieldManager)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getHeatMap(String queryString, String statType)	Generate a heat map and returns a simple bean containing all relievent information
jakarta.ws.rs.core.Response	validateHeatMap(String queryString, String statType)	Ensures all parameters are valid for the heat map

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

HeatMapResource

@Inject
public HeatMapResource(ChartUtils chartUtils,
 JiraAuthenticationContext authenticationContext,
 PermissionManager permissionManager,
 StatisticTypesProvider statisticTypesProvider,
 SearchService searchService,
 VelocityRequestContextFactory velocityRequestContextFactory,
 CustomFieldManager customFieldManager)

Method Details

getHeatMap

@GET
@Path("/generate")
public jakarta.ws.rs.core.Response getHeatMap(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("statType") @DefaultValue("assignees")
 String statType)

Generate a heat map 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

Returns:

a HeatMapResource.HeatMap if all params validated else a Collection of ValidationError

validateHeatMap

@GET
@Path("validate")
public jakarta.ws.rs.core.Response validateHeatMap(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("statType")
 String statType)

Ensures all parameters are valid for the heat map

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.