@InjectableComponent public class

QueryContextConverter

extends Object
java.lang.Object
   ↳ com.atlassian.jira.bc.issue.search.QueryContextConverter

Class Overview

A utlility class for converting a QueryContext into a SearchContext. This conversion only makes sense if the Query the QueryContext was generated from fits the simple navigator.

Summary

Public Constructors
QueryContextConverter()
Public Methods
QueryContext getQueryContext(SearchContext searchContext)
Converts a SearchContext representation into the QueryContext of a search context.
SearchContext getSearchContext(QueryContext queryContext)
Converts a QueryContext into a SearchContext.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public QueryContextConverter ()

Public Methods

public QueryContext getQueryContext (SearchContext searchContext)

Converts a SearchContext representation into the QueryContext of a search context.

As search contexts represented by QueryContexts is a super set of those represented by SearchContext, this coversion will always be valid and never return null.

Parameters
searchContext the context to convert into a QueryContext
Returns

public SearchContext getSearchContext (QueryContext queryContext)

Converts a QueryContext into a SearchContext. If the conversion does not make sense, null is returned.

If you would like to know if this method will correctly generate a SearchContext you should call SearchService#doesQueryFitFilterForm(com.atlassian.crowd.embedded.api.User, com.atlassian.query.Query).

Parameters
queryContext the QueryContext to convert into a SearchContext, if null then a null SearchContext is returned.
Returns
  • the SearchContext generated from the QueryContext, this will be null if we are unable to correctly generate a SearchContext.