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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
      extended by com.atlassian.jira.issue.customfields.searchers.transformer.AbstractSingleValueCustomFieldSearchInputTransformer
All Implemented Interfaces:
SearchInputTransformer
Direct Known Subclasses:
ExactNumberCustomFieldSearchInputTransformer, ExactTextCustomFieldSearchInputTransformer, FreeTextCustomFieldSearchInputTransformer, GroupCustomFieldSearchInputTransformer, ProjectCustomFieldSearchInputTransformer, SelectCustomFieldSearchInputTransformer, UserPickerCustomFieldSearchInputTransformer

public abstract class AbstractSingleValueCustomFieldSearchInputTransformer
extends AbstractCustomFieldSearchInputTransformer

An abstract Search Input Transformer for custom fields that only allow a single value and no functions in the Navigator.

Since:
v4.0

Constructor Summary
AbstractSingleValueCustomFieldSearchInputTransformer(CustomField field, ClauseNames clauseNames, java.lang.String urlParameterName, CustomFieldInputHelper customFieldInputHelper)
           
 
Method Summary
protected  Clause getClauseFromParams(com.opensymphony.user.User searcher, CustomFieldParams customFieldParams)
          Note: only provide a sensible implementation of this if you intend on using AbstractCustomFieldSearchInputTransformer.getSearchClause(com.opensymphony.user.User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here.
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.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
doRelevantClausesFitFilterForm
 

Constructor Detail

AbstractSingleValueCustomFieldSearchInputTransformer

public AbstractSingleValueCustomFieldSearchInputTransformer(CustomField field,
                                                            ClauseNames clauseNames,
                                                            java.lang.String urlParameterName,
                                                            CustomFieldInputHelper customFieldInputHelper)
Method Detail

getClauseFromParams

protected Clause getClauseFromParams(com.opensymphony.user.User searcher,
                                     CustomFieldParams customFieldParams)
Description copied from class: AbstractCustomFieldSearchInputTransformer
Note: only provide a sensible implementation of this if you intend on using AbstractCustomFieldSearchInputTransformer.getSearchClause(com.opensymphony.user.User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here. If you are overriding AbstractCustomFieldSearchInputTransformer.getSearchClause(com.opensymphony.user.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.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".

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.


Copyright © 2002-2010 Atlassian. All Rights Reserved.