com.atlassian.jira.issue.customfields.searchers
Class AbstractSingleValueSearcher

java.lang.Object
  com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher
      com.atlassian.jira.issue.customfields.searchers.AbstractCustomFieldSearcher
          com.atlassian.jira.issue.customfields.searchers.AbstractSingleValueSearcher

All Implemented Interfaces:

CustomFieldSearcher, Field, IssueSearcher, Comparable

Direct Known Subclasses:

ExactNumberSearcher, GroupPickerSearcher, ProjectSearcher, SelectSearcher, TextSearcher, UserPickerSearcher

public abstract class AbstractSingleValueSearcher
extends AbstractCustomFieldSearcher

Field Summary

Fields inherited from class com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher

authenticationContext, customField, descriptor

Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher

I18N_BUNDLE

Constructor Summary

AbstractSingleValueSearcher(FieldVisibilityBean fieldVisibilityBean)

Method Summary

CustomFieldParams	getParamsFromSearchRequest(CustomField customField, SearchRequest searchRequest)
String	getQuerySnippet(CustomField customField, SearchRequest searchRequest) Returns a query string that can be interpreted by the IssueNavigator action to execute this as a search request.
protected abstract Collection	getValueFromSearchRequest(SearchParameter searchParameter)
protected Object	getViewObject(Object o)
protected abstract SearchParameter	makeSearchParameter(CustomField field, String paramValue, String paramPrefix)
List	makeSearchParameters(CustomField field, CustomFieldParams customFieldParams)

Methods inherited from class com.atlassian.jira.issue.customfields.searchers.AbstractCustomFieldSearcher

getEditHtml, getI18n, getQuerySnippet, getRelatedIndexers, getViewHtml, index, isExistsInSeachRequest, isRevelentForSeachRequest, populateFromParams, populateFromParams, populateFromSearchRequest, populateSearchRequest, validateParams, validateParams

Methods inherited from class com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher

compareTo, getDescriptor, getId, getName, getNameKey, getStringValue, getValue, init, init, isShown, register

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSingleValueSearcher

public AbstractSingleValueSearcher(FieldVisibilityBean fieldVisibilityBean)

Method Detail

makeSearchParameters

public List makeSearchParameters(CustomField field,
                                 CustomFieldParams customFieldParams)

Specified by:

makeSearchParameters in class AbstractCustomFieldSearcher

customFieldParams - must never be null

Returns:

List of SearchParameters.

getParamsFromSearchRequest

public CustomFieldParams getParamsFromSearchRequest(CustomField customField,
                                                    SearchRequest searchRequest)

Specified by:

getParamsFromSearchRequest in class AbstractCustomFieldSearcher

getQuerySnippet

public String getQuerySnippet(CustomField customField,
                              SearchRequest searchRequest)

Description copied from class: AbstractCustomFieldSearcher

Returns a query string that can be interpreted by the IssueNavigator action to execute this as a search request. The query string can then be used to partially reconstruct the searchRequest being passed i. The returned query string should be encoded using JiraUrlCodec.encode(java.lang.String) and begin with an &.

Specified by:

getQuerySnippet in class AbstractCustomFieldSearcher

Parameters:

customField - - custom field call this method

searchRequest - - the search request to get the url parameters from

Returns:

String encoded query string

getViewObject

protected Object getViewObject(Object o)

getValueFromSearchRequest

protected abstract Collection getValueFromSearchRequest(SearchParameter searchParameter)

makeSearchParameter

protected abstract SearchParameter makeSearchParameter(CustomField field,
                                                       String paramValue,
                                                       String paramPrefix)
                                                throws FieldValidationException

Throws:

FieldValidationException