com.atlassian.jira.issue.search.searchers.transformer
Class CustomFieldLabelsSearchInputTransformer

java.lang.Object
  com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
      com.atlassian.jira.issue.search.searchers.transformer.CustomFieldLabelsSearchInputTransformer

All Implemented Interfaces:

SearchInputTransformer

public class CustomFieldLabelsSearchInputTransformer
extends AbstractCustomFieldSearchInputTransformer

The SearchInputTransformer for the Labels custom field.

Since:

v4.2

Constructor Summary

CustomFieldLabelsSearchInputTransformer(CustomField field, String urlParameterName, CustomFieldInputHelper customFieldInputHelper, ClauseNames clauseNames)

Method Summary

boolean	doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.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 Clause	getClauseFromParams(com.atlassian.crowd.embedded.api.User searcher, 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 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.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

Constructor Detail

CustomFieldLabelsSearchInputTransformer

public CustomFieldLabelsSearchInputTransformer(CustomField field,
                                               String urlParameterName,
                                               CustomFieldInputHelper customFieldInputHelper,
                                               ClauseNames clauseNames)

Method Detail

getClauseFromParams

protected Clause getClauseFromParams(com.atlassian.crowd.embedded.api.User searcher,
                                     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:

searcher - 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 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".

Specified by:

getParamsFromSearchRequest in class AbstractCustomFieldSearchInputTransformer

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.atlassian.crowd.embedded.api.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.

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.