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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
All Implemented Interfaces:
SearchInputTransformer
Direct Known Subclasses:
AbstractSingleValueCustomFieldSearchInputTransformer, CascadingSelectCustomFieldSearchInputTransformer, MultiSelectCustomFieldSearchInputTransformer, NumberRangeCustomFieldSearchInputTransformer, VersionCustomFieldSearchInputTransformer

public abstract class AbstractCustomFieldSearchInputTransformer
extends Object
implements SearchInputTransformer

An abstract implementation for a search input transformer for custom fields. Assumes the custom field params contain a single mapping from field to value.

Since:
v4.0

Constructor Summary
AbstractCustomFieldSearchInputTransformer(CustomField field, String urlParameterName, CustomFieldInputHelper customFieldInputHelper)
           
 
Method Summary
protected abstract  Clause getClauseFromParams(User searcher, CustomFieldParams customFieldParams)
          Note: only provide a sensible implementation of this if you intend on using getSearchClause(com.opensymphony.user.User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here.
protected  String getClauseName(User searcher, ClauseNames clauseNames)
           
protected  CustomField getCustomField()
           
protected abstract  CustomFieldParams getParamsFromSearchRequest(User searcher, Query query, SearchContext searchContext)
          Gets CustomField search parameters from the given JQL Query.
 Clause getSearchClause(User searcher, FieldValuesHolder fieldValuesHolder)
          Gets the portion of the Search Query that this searcher is responsible for.
 void populateFromParams(User user, FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
          Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams.
 void populateFromQuery(User searcher, FieldValuesHolder fieldValuesHolder, Query query, SearchContext searchContext)
          This method transforms any query information contained in the query that is relevant to this SearchInputTransformer into the values that the HTML rendering expects.
 void validateParams(User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
          Adds error meessages to the errors object if values in the fieldValuesHolder fails validation.
 
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

AbstractCustomFieldSearchInputTransformer

public AbstractCustomFieldSearchInputTransformer(CustomField field,
                                                 String urlParameterName,
                                                 CustomFieldInputHelper customFieldInputHelper)
Method Detail

getClauseFromParams

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

Parameters:
searcher - the user performing the search
customFieldParams - the custom field params
Returns:
the clause that represents the params

getParamsFromSearchRequest

protected abstract CustomFieldParams getParamsFromSearchRequest(User searcher,
                                                                Query query,
                                                                SearchContext searchContext)
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".

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.

getSearchClause

public Clause getSearchClause(User searcher,
                              FieldValuesHolder fieldValuesHolder)
Description copied from interface: SearchInputTransformer
Gets the portion of the Search Query that this searcher is responsible for.

Specified by:
getSearchClause in interface SearchInputTransformer
Parameters:
searcher - performing this action.
fieldValuesHolder - contains values populated by the searchers
Returns:
a Clause that represents the users search based on the fieldValuesHolder; null if this searcher has no responsibility in the given input.

populateFromParams

public void populateFromParams(User user,
                               FieldValuesHolder fieldValuesHolder,
                               ActionParams actionParams)
Description copied from interface: SearchInputTransformer
Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams. This transforms the "raw" request parameters into a form that the other processing methods can handle (usually a mapping of the fields name as the key and a list of the values as the value).

Specified by:
populateFromParams in interface SearchInputTransformer
Parameters:
user - performing this action.
fieldValuesHolder - is the object that should have its values set by this method and that will contain any other values that have been set by other SearchInputTransformers.
actionParams - params from the webwork front end that contains a String[] of values as submitted via the

populateFromQuery

public void populateFromQuery(User searcher,
                              FieldValuesHolder fieldValuesHolder,
                              Query query,
                              SearchContext searchContext)
Description copied from interface: SearchInputTransformer
This method transforms any query information contained in the query that is relevant to this SearchInputTransformer into the values that the HTML rendering expects. This should populate the FieldValuesHolder from the a query information in the query.
The query elements that are considered "relevant" to this method would be those that are produced by the SearchInputTransformer.getSearchClause(com.opensymphony.user.User,com.atlassian.jira.issue.transport.FieldValuesHolder) method.

Specified by:
populateFromQuery in interface SearchInputTransformer
Parameters:
searcher - performing this action.
fieldValuesHolder - is the object that should have its values set by this method and that will contain any other values that have been set by other SearchInputTransformers.
query - the search criteria used to populate the field values holder.
searchContext - contains the projects and issue types that the search and filter form is restricted to

validateParams

public void validateParams(User user,
                           SearchContext searchContext,
                           FieldValuesHolder fieldValuesHolder,
                           I18nHelper i18nHelper,
                           ErrorCollection errors)
Description copied from interface: SearchInputTransformer
Adds error meessages to the errors object if values in the fieldValuesHolder fails validation. This should be called once the fieldValuesHolder has been populated.

Specified by:
validateParams in interface SearchInputTransformer
Parameters:
user - performing this action.
searchContext - the context of the search (i.e. projects and issue types selected).
fieldValuesHolder - contains values populated by the populate methods of this input transformer.
i18nHelper - used to internationalize error messages that we want to display to the users.
errors - the ErrorCollection that contains the messages we want to display to the users.

getClauseName

protected String getClauseName(User searcher,
                               ClauseNames clauseNames)

getCustomField

protected CustomField getCustomField()


Copyright © 2002-2009 Atlassian. All Rights Reserved.