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

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

@NonInjectableComponent
public class CascadingSelectCustomFieldSearchInputTransformer
extends AbstractCustomFieldSearchInputTransformer
implements SearchInputTransformer

The SearchInputTransformer for cascading select custom fields.

Since:
v4.0

Constructor Summary
CascadingSelectCustomFieldSearchInputTransformer(ClauseNames clauseNames, CustomField field, String urlParameterName, SelectConverter selectConverter, JqlOperandResolver jqlOperandResolver, JqlSelectOptionsUtil jqlSelectOptionsUtil, JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil, QueryContextConverter queryContextConverter, CustomFieldInputHelper customFieldInputHelper)
           
 
Method Summary
 boolean doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.User user, 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  Clause getClauseFromParams(com.atlassian.crowd.embedded.api.User user, CustomFieldParams customFieldParams)
          Note: only provide a sensible implementation of this if you intend on using AbstractCustomFieldSearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here.
protected  CustomFieldParams getParamsFromSearchRequest(com.atlassian.crowd.embedded.api.User user, Query query, SearchContext searchContext)
          Gets CustomField search parameters from the given JQL Query.
 
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

CascadingSelectCustomFieldSearchInputTransformer

public CascadingSelectCustomFieldSearchInputTransformer(ClauseNames clauseNames,
                                                        CustomField field,
                                                        String urlParameterName,
                                                        SelectConverter selectConverter,
                                                        JqlOperandResolver jqlOperandResolver,
                                                        JqlSelectOptionsUtil jqlSelectOptionsUtil,
                                                        JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil,
                                                        QueryContextConverter queryContextConverter,
                                                        CustomFieldInputHelper customFieldInputHelper)
Method Detail

doRelevantClausesFitFilterForm

public boolean doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.User user,
                                              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:
user - 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.

getClauseFromParams

protected Clause getClauseFromParams(com.atlassian.crowd.embedded.api.User user,
                                     CustomFieldParams customFieldParams)
Description copied from class: AbstractCustomFieldSearchInputTransformer
Note: only provide a sensible implementation of this if you intend on using AbstractCustomFieldSearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here. If you are overriding AbstractCustomFieldSearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) then you do not have to implement this method sensibly.

Specified by:
getClauseFromParams in class AbstractCustomFieldSearchInputTransformer
Parameters:
user - the user performing the search
customFieldParams - the custom field params
Returns:
the clause that represents the params

getParamsFromSearchRequest

protected CustomFieldParams getParamsFromSearchRequest(com.atlassian.crowd.embedded.api.User user,
                                                       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".

Specified by:
getParamsFromSearchRequest in class AbstractCustomFieldSearchInputTransformer
Parameters:
user - 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.


Copyright © 2002-2013 Atlassian. All Rights Reserved.