public class

TwoDimensionalStatsResource

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

Class Overview

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

Summary

Nested Classes
class TwoDimensionalStatsResource.Cell  
class TwoDimensionalStatsResource.FilterProperties  
class TwoDimensionalStatsResource.Row  
class TwoDimensionalStatsResource.TwoDimensionalProperties  
[Expand]
Inherited Constants
From class com.atlassian.jira.gadgets.system.SearchQueryBackedResource
[Expand]
Inherited Fields
From class com.atlassian.jira.gadgets.system.SearchQueryBackedResource
Public Constructors
TwoDimensionalStatsResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, SearchService searchService, PermissionManager permissionManager, StatisticTypesProvider statisticTypesProvider, SearchProvider searchProvider, VelocityRequestContextFactory velocityRequestContextFactory, FieldValueToDisplayTransformer<StatsMarkup> fieldValueToDisplayTransformer, FieldManager fieldManager, FieldVisibilityManager fieldVisibilityManager, ReaderCache readerCache)
Public Methods
Response getStats(String queryString, String xStatType, String yStatType, String sortDirection, String sortBy, String numberToShowStr)
Generate a two dimensional statistics view of a filter
Response validate(String queryString, String xStatType, String yStatType, String numberToShow)
Protected Methods
TwoDimensionalStatsMap getAndPopulateTwoDimensionalStatsMap(StatisticsMapper xAxisMapper, StatisticsMapper yAxisMapper, SearchRequest searchRequest)
StatsSearchUrlBuilder getStatsSearchUrlBuilder()
[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 TwoDimensionalStatsResource (ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, SearchService searchService, PermissionManager permissionManager, StatisticTypesProvider statisticTypesProvider, SearchProvider searchProvider, VelocityRequestContextFactory velocityRequestContextFactory, FieldValueToDisplayTransformer<StatsMarkup> fieldValueToDisplayTransformer, FieldManager fieldManager, FieldVisibilityManager fieldVisibilityManager, ReaderCache readerCache)

Public Methods

public Response getStats (String queryString, String xStatType, String yStatType, String sortDirection, String sortBy, 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

public Response validate (String queryString, String xStatType, String yStatType, String numberToShow)

Protected Methods

protected TwoDimensionalStatsMap getAndPopulateTwoDimensionalStatsMap (StatisticsMapper xAxisMapper, StatisticsMapper yAxisMapper, SearchRequest searchRequest)

protected StatsSearchUrlBuilder getStatsSearchUrlBuilder ()