Package com.atlassian.jira.gadgets.system

Class SearchQueryBackedResource

java.lang.Object

com.atlassian.jira.gadgets.system.AbstractResource

com.atlassian.jira.gadgets.system.SearchQueryBackedResource

Direct Known Subclasses:

AverageAgeChartResource, BubbleChartResource, CreatedVsResolvedResource, HeatMapResource, PieChartResource, RecentlyCreatedChartResource, ResolutionTimeResource, StatsResource, TimeSinceChartResource, TwoDimensionalStatsResource

public abstract class SearchQueryBackedResource
extends AbstractResource

An abstract class used for common search request handling for search request backed resources.

Since:

v4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final JiraAuthenticationContext	authenticationContext
protected static final String	QUERY_STRING
protected final SearchService	searchService

Constructor Summary

Constructors

Constructor	Description
SearchQueryBackedResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, SearchService searchService, PermissionManager permissionManager, VelocityRequestContextFactory velocityRequestContextFactory)

Method Summary

Modifier and Type	Method	Description
protected String	getFilterTitle(Map<String,Object> params)	Get the name to display for the given query.
protected String	getFilterUrl(Map<String,Object> params)	Get the url to send people to for this search.
protected SearchRequest	getSearchRequestAndValidate(String queryString, Collection<ValidationError> errors, Map<String,Object> params)	Method used for retrieving/building a SearchRequest and validating params.
protected void	validateSize(Collection<ValidationError> errors, int width, int height)

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

Field Details

QUERY_STRING

protected static final String QUERY_STRING

See Also:

• Constant Field Values

authenticationContext

protected final JiraAuthenticationContext authenticationContext

searchService

protected final SearchService searchService

Constructor Details

SearchQueryBackedResource

@Inject
public SearchQueryBackedResource(ChartUtils chartUtils,
 JiraAuthenticationContext authenticationContext,
 SearchService searchService,
 PermissionManager permissionManager,
 VelocityRequestContextFactory velocityRequestContextFactory)

Method Details

getSearchRequestAndValidate

protected SearchRequest getSearchRequestAndValidate(String queryString,
 Collection<ValidationError> errors,
 Map<String,Object> params)

Method used for retrieving/building a SearchRequest and validating params.

Parameters:

queryString - a String containing a search criteria. Starts with "filter-" for a search request, "project-" for a project or "jql-" for a jql equest.

errors - a collection of ValidationError object containing all validation message keys.

params - a map to populate with with appropriate entities.

Returns:

a SearchRequest that will restrict the search to the given criteria

validateSize

protected void validateSize(Collection<ValidationError> errors,
 int width,
 int height)

getFilterTitle

protected String getFilterTitle(Map<String,Object> params)

Get the name to display for the given query.

Parameters:

params - The params created during chart generation process.

Returns:

For a project, get the project name. For a saved filter, get the name. For a unsaved search, return the anonymous key.

getFilterUrl

protected String getFilterUrl(Map<String,Object> params)

Get the url to send people to for this search.

Parameters:

params - The params created during chart generation process.

Returns:

For a project or filter, send them to the issue navigator. For an unsaved search, return empty string.