Package com.atlassian.jira.issue.statistics

Class StatisticsMapGenerator

java.lang.Object

com.atlassian.jira.issue.statistics.StatisticsMapGenerator

@Internal
public class StatisticsMapGenerator
extends Object

Generates a map of statistics for a given filter producing a StatisticMap.
Extracted from the deprecated Lucene DMZ module for compatibility with the Search API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatisticsMapGenerator.Direction	Enumerated type for sort direction.
static class	StatisticsMapGenerator.OrderBy	Enumerated type for ordering of statistics.
protected static class	StatisticsMapGenerator.SearchStatisticsResult

Constructor Summary

Constructors

Constructor	Description
StatisticsMapGenerator()
StatisticsMapGenerator(ApplicationUser remoteUser, SearchRequest filter)
StatisticsMapGenerator(ApplicationUser remoteUser, SearchRequest filter, boolean overrideSecurity)
StatisticsMapGenerator(ApplicationUser remoteUser, Long projectId)
StatisticsMapGenerator(ApplicationUser remoteUser, Long projectId, boolean limitToOpenIssues)
StatisticsMapGenerator(ApplicationUser remoteUser, Long projectId, Clause additionalClause, boolean limitToOpenIssues)	Instantiates this class with given parameters.

Method Summary

Modifier and Type	Method	Description
StatisticMapWrapper	generateStatisticMapWrapper(StatisticsMapper mapper)
StatisticMapWrapper	generateStatisticMapWrapper(StatisticsMapper mapper, StatisticsMapGenerator.OrderBy orderBy, StatisticsMapGenerator.Direction direction)	Returns a StatisticMapWrapper containing ordered search statistic results
StatisticMapWrapper	getAllFilterBy(String type)
StatisticMapWrapper	getAllFilterBy(String type, StatisticsMapGenerator.OrderBy orderBy, StatisticsMapGenerator.Direction direction)
long	getCount()	Returns nuber of search results for this filter
SearchRequest	getFilter()
Collection	getIssues()	Returns a collection of found issues for this filter
StatisticsMapper	getMapper(String type)
long	getOpenByComponent()	Stats by Component
long	getOpenByComponent(org.ofbiz.core.entity.GenericValue component)
long	getOpenByFixFor()	Stats by FixFor
long	getOpenByFixFor(Version version)
SearchRequestAppender	getSearchRequestAppender(String statisticType)	This will obtain a SearchRequestAppender relevant for the given statisticType, either by casting the StatisticsMapper to SearchRequestAppender.Factory or by constructing an artificial SearchRequestAppender wrapper around the StatisticsMapper.
protected StatisticsMapGenerator.SearchStatisticsResult	searchCountMap(String groupField)

Methods inherited from class java.lang.Object

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

Constructor Details

StatisticsMapGenerator

public StatisticsMapGenerator()

StatisticsMapGenerator

public StatisticsMapGenerator(ApplicationUser remoteUser,
 SearchRequest filter)

StatisticsMapGenerator

public StatisticsMapGenerator(ApplicationUser remoteUser,
 SearchRequest filter,
 boolean overrideSecurity)

StatisticsMapGenerator

public StatisticsMapGenerator(ApplicationUser remoteUser,
 Long projectId,
 boolean limitToOpenIssues)

StatisticsMapGenerator

public StatisticsMapGenerator(ApplicationUser remoteUser,
 Long projectId)

StatisticsMapGenerator

public StatisticsMapGenerator(ApplicationUser remoteUser,
 Long projectId,
 Clause additionalClause,
 boolean limitToOpenIssues)

Instantiates this class with given parameters.

Parameters:

remoteUser - remote User

projectId - project id

additionalClause - An additional clause to and to the current filter. Can be null.

limitToOpenIssues - flag that limits issues on status (open vs other)

Since:

10.7

Method Details

getFilter

public SearchRequest getFilter()

generateStatisticMapWrapper

public StatisticMapWrapper generateStatisticMapWrapper(StatisticsMapper mapper)
                                                throws SearchException

Throws:

SearchException

generateStatisticMapWrapper

public StatisticMapWrapper generateStatisticMapWrapper(StatisticsMapper mapper,
 StatisticsMapGenerator.OrderBy orderBy,
 StatisticsMapGenerator.Direction direction)
                                                throws SearchException

Returns a StatisticMapWrapper containing ordered search statistic results

Parameters:

mapper - the relevant StatisticsMapper for this instance

orderBy - either OrderBy.NATURAL or OrderBy.TOTAL to specify ordering by result keys or values respectively. null produces the same result as OrderBy.NATURAL

direction - either Direction.DESC or Direction.ASC to specify direction of ordering. null produces the same result as Direction.ASC

Returns:

the ordered results

Throws:

SearchException - .

searchCountMap

protected StatisticsMapGenerator.SearchStatisticsResult searchCountMap(String groupField)
                                                                throws SearchException

Throws:

SearchException

getOpenByComponent

public long getOpenByComponent()
                        throws SearchException

Stats by Component

Throws:

SearchException

getOpenByComponent

public long getOpenByComponent(org.ofbiz.core.entity.GenericValue component)
                        throws SearchException

Throws:

SearchException

getOpenByFixFor

public long getOpenByFixFor()
                     throws SearchException

Stats by FixFor

Throws:

SearchException

getOpenByFixFor

public long getOpenByFixFor(Version version)
                     throws SearchException

Throws:

SearchException

getCount

public long getCount()
              throws SearchException

Returns nuber of search results for this filter

Returns:

count

Throws:

SearchException - if search fails

Since:

v3.10

getIssues

public Collection getIssues()
                     throws SearchException

Returns a collection of found issues for this filter

Returns:

collection of Issue objects

Throws:

SearchException - if search fails

Since:

v3.10

getAllFilterBy

public StatisticMapWrapper getAllFilterBy(String type)
                                   throws SearchException

Throws:

SearchException

getAllFilterBy

public StatisticMapWrapper getAllFilterBy(String type,
 StatisticsMapGenerator.OrderBy orderBy,
 StatisticsMapGenerator.Direction direction)
                                   throws SearchException

Throws:

SearchException

getMapper

public StatisticsMapper getMapper(String type)

getSearchRequestAppender

public SearchRequestAppender getSearchRequestAppender(String statisticType)

This will obtain a SearchRequestAppender relevant for the given statisticType, either by casting the StatisticsMapper to SearchRequestAppender.Factory or by constructing an artificial SearchRequestAppender wrapper around the StatisticsMapper.