com.atlassian.jira.bc.issue.search
Class QueryContextConverter

java.lang.Object
  extended by com.atlassian.jira.bc.issue.search.QueryContextConverter

@InjectableComponent
public class QueryContextConverter
extends java.lang.Object

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.

Since:
v4.0

Constructor Summary
QueryContextConverter()
           
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryContextConverter

public QueryContextConverter()
Method Detail

getQueryContext

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:
the context represented by a QueryContext. Never Null.

getSearchContext

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.opensymphony.user.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.


Copyright © 2002-2010 Atlassian. All Rights Reserved.