com.atlassian.jira.issue.customfields.searchers.transformer
Class SelectCustomFieldSearchInputTransformer

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
      extended by com.atlassian.jira.issue.customfields.searchers.transformer.AbstractSingleValueCustomFieldSearchInputTransformer
          extended by com.atlassian.jira.issue.customfields.searchers.transformer.SelectCustomFieldSearchInputTransformer
All Implemented Interfaces:
SearchInputTransformer

public class SelectCustomFieldSearchInputTransformer
extends AbstractSingleValueCustomFieldSearchInputTransformer
implements SearchInputTransformer

The SearchInputTransformer for select custom fields.

Since:
v4.0

Constructor Summary
SelectCustomFieldSearchInputTransformer(CustomField field, ClauseNames clauseNames, java.lang.String urlParameterName, JqlSelectOptionsUtil jqlSelectOptionsUtil, QueryContextConverter queryContextConverter, CustomFieldInputHelper customFieldInputHelper)
           
 
Method Summary
 boolean doRelevantClausesFitFilterForm(com.opensymphony.user.User searcher, Query query, SearchContext searchContext)
          Tells the caller whether or not the relevant clauses from the passed query can be represented on the issue navigator.
protected  CustomFieldParams getParamsFromSearchRequest(com.opensymphony.user.User searcher, Query query, SearchContext searchContext)
          Gets CustomField search parameters from the given JQL Query.
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractSingleValueCustomFieldSearchInputTransformer
getClauseFromParams
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
getClauseName, getCustomField, getSearchClause, populateFromParams, populateFromQuery, validateParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer
getSearchClause, populateFromParams, populateFromQuery, validateParams
 

Constructor Detail

SelectCustomFieldSearchInputTransformer

public SelectCustomFieldSearchInputTransformer(CustomField field,
                                               ClauseNames clauseNames,
                                               java.lang.String urlParameterName,
                                               JqlSelectOptionsUtil jqlSelectOptionsUtil,
                                               QueryContextConverter queryContextConverter,
                                               CustomFieldInputHelper customFieldInputHelper)
Method Detail

getParamsFromSearchRequest

protected CustomFieldParams getParamsFromSearchRequest(com.opensymphony.user.User searcher,
                                                       Query query,
                                                       SearchContext searchContext)
Description copied from class: AbstractCustomFieldSearchInputTransformer
Gets CustomField search parameters from the given JQL Query.

it may return null, indicating no search parameters for this searcher were specified, or the query will not fit into the "simple navigator".

Overrides:
getParamsFromSearchRequest in class AbstractSingleValueCustomFieldSearchInputTransformer
Parameters:
searcher - User
query - JQL query
searchContext - contains the projects and issue types that the search is restricted to
Returns:
CustomField search parameters from the given JQL Query.

doRelevantClausesFitFilterForm

public boolean doRelevantClausesFitFilterForm(com.opensymphony.user.User searcher,
                                              Query query,
                                              SearchContext searchContext)
Description copied from interface: SearchInputTransformer
Tells the caller whether or not the relevant clauses from the passed query can be represented on the issue navigator. Implementors of this method needs to ensure that it can represent *ALL* related clauses on the navigator, and that the clauses' structure conforms to the simple navigator structure.

The method should only be concerned with the clauses related to this transformer. Other irrelevant clauses should be ignored.

Specified by:
doRelevantClausesFitFilterForm in interface SearchInputTransformer
Parameters:
searcher - performing this action.
query - to check if it can fit in the simple (GUI form based) issue navigator.
searchContext - contains the projects and issue types that the search and filter form is restricted to
Returns:
true if the query can be represented on navigator.


Copyright © 2002-2010 Atlassian. All Rights Reserved.