Package com.atlassian.jira.gadgets.system

Class TwoDimensionalStatsResource

java.lang.Object

com.atlassian.jira.gadgets.system.AbstractResource

com.atlassian.jira.gadgets.system.SearchQueryBackedResource

com.atlassian.jira.gadgets.system.TwoDimensionalStatsResource

@Path("/twodimensionalfilterstats")
@Produces("application/json")
public class TwoDimensionalStatsResource
extends SearchQueryBackedResource

REST endpoint to validate and retreive a two dimensional stats resource.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TwoDimensionalStatsResource.Cell
static class	TwoDimensionalStatsResource.FilterProperties
static class	TwoDimensionalStatsResource.Row
static class	TwoDimensionalStatsResource.TwoDimensionalProperties

Field Summary

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

authenticationContext, QUERY_STRING, searchService

Constructor Summary

Constructors

Constructor	Description
TwoDimensionalStatsResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, SearchService searchService, PermissionManager permissionManager, StatisticTypesProvider statisticTypesProvider, VelocityRequestContextFactory velocityRequestContextFactory, FieldValueToDisplayTransformer<StatsMarkup> fieldValueToDisplayTransformer, TwoDimensionalAggregator aggregationSearcher)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getStats(String queryString, String xStatType, String yStatType, String sortDirection, String sortBy, String numberToShowStr)	Generate a two dimensional statistics view of a filter
protected com.atlassian.jira.gadgets.system.StatsSearchUrlBuilder	getStatsSearchUrlBuilder()
jakarta.ws.rs.core.Response	validate(String queryString, String xStatType, String yStatType, String numberToShow)

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

TwoDimensionalStatsResource

@Inject
public TwoDimensionalStatsResource(ChartUtils chartUtils,
 JiraAuthenticationContext authenticationContext,
 SearchService searchService,
 PermissionManager permissionManager,
 StatisticTypesProvider statisticTypesProvider,
 VelocityRequestContextFactory velocityRequestContextFactory,
 FieldValueToDisplayTransformer<StatsMarkup> fieldValueToDisplayTransformer,
 TwoDimensionalAggregator aggregationSearcher)

Method Details

validate

@GET
@Path("validate")
public jakarta.ws.rs.core.Response validate(@QueryParam("filterId")
 String queryString,
 @QueryParam("xstattype")
 String xStatType,
 @QueryParam("ystattype")
 String yStatType,
 @QueryParam("numberToShow")
 String numberToShow)

getStats

@GET
@Path("/generate")
public jakarta.ws.rs.core.Response getStats(@QueryParam("filterId")
 String queryString,
 @QueryParam("xstattype") @DefaultValue("assignees")
 String xStatType,
 @QueryParam("ystattype") @DefaultValue("assignees")
 String yStatType,
 @QueryParam("sortDirection") @DefaultValue("asc")
 String sortDirection,
 @QueryParam("sortBy") @DefaultValue("natural")
 String sortBy,
 @QueryParam("numberToShow") @DefaultValue("5")
 String numberToShowStr)

Generate a two dimensional statistics view of a filter

Parameters:

queryString - a filter id (starts with "filter-", or just the number)

xStatType - The stat to group by on the x axis

yStatType - The stat to group by on the y axis

sortDirection - Ascending or descending sort

sortBy - The field with which to order the stats

numberToShowStr - Maximum number of results to display on the y-axis. 0 represents unlimited.

Returns:

a TwoDimensionalStatsResource.TwoDimensionalProperties if all params validate else a Collection of ValidationError

getStatsSearchUrlBuilder

protected com.atlassian.jira.gadgets.system.StatsSearchUrlBuilder getStatsSearchUrlBuilder()