Package com.atlassian.jira.issue.customfields.searchers

Class UserPickerSearcher

java.lang.Object

com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher

com.atlassian.jira.issue.customfields.searchers.UserPickerSearcher

All Implemented Interfaces:

CustomFieldSearcher, FieldSortsCustomFieldSearcher, CustomFieldStattable, ValueLoaderCustomFieldSearcher, IssueSearcher<CustomField>

@PublicSpi
@PublicApi
public class UserPickerSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, ValueLoaderCustomFieldSearcher, FieldSortsCustomFieldSearcher, CustomFieldStattable

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
UserPickerSearcher(UserResolver userResolver, JqlOperandResolver operandResolver, JiraAuthenticationContext context, UserConverter userConverter, UserSearchService userSearchService, CustomFieldInputHelper customFieldInputHelper, UserManager userManager, FieldVisibilityManager fieldVisibilityManager, EmailFormatter emailFormatter)

Method Summary

Modifier and Type	Method	Description
CustomFieldSearcherClauseHandler	getCustomFieldSearcherClauseHandler()	Provides an object that can be used to handle the clauses that this searcher generates.
List<FieldSort>	getFieldSorts(CustomField customField, FieldSort.Order order)	Get the index field sorts for the provided custom field
SearcherInformation<CustomField>	getSearchInformation()	Provides an object that contains information about the Searcher.
SearchInputTransformer	getSearchInputTransformer()	Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.
SearchRenderer	getSearchRenderer()	Provides an object that will allow you to render the edit and view html for a searcher.
StatisticsMapper	getStatisticsMapper(CustomField customField)	Since Jira v8.0 a "stattable" field must have a doc value of type: SortedDocValues, SortedSetDocValues, BinaryDocValues, or NumericDocValues.
FieldValueLoader<?>	getValueLoader(CustomField customField)	Gets the value loader for the provided custom field.
void	init(CustomField field)	This is the first time the searcher knows what its ID and names are

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

getDescriptor, init

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.customfields.CustomFieldSearcher

getDescriptor, init

Constructor Details

UserPickerSearcher

public UserPickerSearcher(UserResolver userResolver,
 JqlOperandResolver operandResolver,
 JiraAuthenticationContext context,
 UserConverter userConverter,
 UserSearchService userSearchService,
 CustomFieldInputHelper customFieldInputHelper,
 UserManager userManager,
 FieldVisibilityManager fieldVisibilityManager,
 EmailFormatter emailFormatter)

Method Details

init

public void init(CustomField field)

This is the first time the searcher knows what its ID and names are

Specified by:

init in interface IssueSearcher<CustomField>

Parameters:

field - the Custom Field for this searcher

getSearchInformation

public SearcherInformation<CustomField> getSearchInformation()

Description copied from interface: IssueSearcher

Provides an object that contains information about the Searcher.

Specified by:

getSearchInformation in interface IssueSearcher<CustomField>

Returns:

the search information provider for this searcher.

getSearchInputTransformer

public SearchInputTransformer getSearchInputTransformer()

Description copied from interface: IssueSearcher

Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.

Specified by:

getSearchInputTransformer in interface IssueSearcher<CustomField>

Returns:

the search input handler for this searcher.

getSearchRenderer

public SearchRenderer getSearchRenderer()

Description copied from interface: IssueSearcher

Provides an object that will allow you to render the edit and view html for a searcher. This also provides methods that indicate if the view and edit methods should be invoked.

Specified by:

getSearchRenderer in interface IssueSearcher<CustomField>

Returns:

the search renderer for this searcher.

getCustomFieldSearcherClauseHandler

public CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()

Description copied from interface: CustomFieldSearcher

Provides an object that can be used to handle the clauses that this searcher generates.

Specified by:

getCustomFieldSearcherClauseHandler in interface CustomFieldSearcher

Returns:

an object that can be used to handle the clauses that this searcher generates, can be null.

getStatisticsMapper

public StatisticsMapper getStatisticsMapper(CustomField customField)

Description copied from interface: CustomFieldStattable

Since Jira v8.0 a "stattable" field must have a doc value of type: SortedDocValues, SortedSetDocValues, BinaryDocValues, or NumericDocValues. Before Jira v8.0 "stattable" fields were retrieved from a Jira cache build from from Lucene index. Since Jira v8.0 this cache is using Lucene DocValues directly. See DocValues and supported implementations for details.

Specified by:

getStatisticsMapper in interface CustomFieldStattable

getFieldSorts

public List<FieldSort> getFieldSorts(CustomField customField,
 FieldSort.Order order)

Description copied from interface: FieldSortsCustomFieldSearcher

Get the index field sorts for the provided custom field

Specified by:

getFieldSorts in interface FieldSortsCustomFieldSearcher

Returns:

the index field sorts for the provided custom field

getValueLoader

public FieldValueLoader<?> getValueLoader(CustomField customField)

Description copied from interface: ValueLoaderCustomFieldSearcher

Gets the value loader for the provided custom field.

Specified by:

getValueLoader in interface ValueLoaderCustomFieldSearcher

Returns:

the value loader for the provided custom field