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

Class ProjectSearcher

java.lang.Object

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

com.atlassian.jira.issue.customfields.searchers.ProjectSearcher

All Implemented Interfaces:

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

public class ProjectSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, SortableCustomFieldSearcher, CustomFieldStattable

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
ProjectSearcher(FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver jqlOperandResolver, ProjectConverter projectConverter, ProjectResolver projectResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, ProjectManager projectManager, PermissionManager permissionManager, CustomFieldInputHelper customFieldInputHelper)	Deprecated.
ProjectSearcher(FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver jqlOperandResolver, ProjectConverter projectConverter, ProjectResolver projectResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, ProjectManager projectManager, PermissionManager permissionManager, InternalProjectPermissionHelper projectPermissionHelper, CustomFieldInputHelper customFieldInputHelper)

Method Summary

Modifier and Type	Method	Description
CustomFieldSearcherClauseHandler	getCustomFieldSearcherClauseHandler()	Provides an object that can be used to handle the clauses that this searcher generates.
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.
LuceneFieldSorter	getSorter(CustomField customField)	Returns a LuceneFieldSorter that can be used to sort the values of the custom field.
StatisticsMapper	getStatisticsMapper(CustomField customField)	Since Jira v8.0 a "stattable" field must have a doc value of type: SortedDocValues, SortedSetDocValues, BinaryDocValues, or NumericDocValues.
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

Methods inherited from interface com.atlassian.jira.issue.customfields.SortableCustomFieldSearcher

getFieldSorts, getValueLoader

Constructor Details

ProjectSearcher

@Deprecated
public ProjectSearcher(FieldVisibilityManager fieldVisibilityManager,
 JqlOperandResolver jqlOperandResolver,
 ProjectConverter projectConverter,
 ProjectResolver projectResolver,
 FieldFlagOperandRegistry fieldFlagOperandRegistry,
 ProjectManager projectManager,
 PermissionManager permissionManager,
 CustomFieldInputHelper customFieldInputHelper)

Deprecated.

ProjectSearcher

public ProjectSearcher(FieldVisibilityManager fieldVisibilityManager,
 JqlOperandResolver jqlOperandResolver,
 ProjectConverter projectConverter,
 ProjectResolver projectResolver,
 FieldFlagOperandRegistry fieldFlagOperandRegistry,
 ProjectManager projectManager,
 PermissionManager permissionManager,
 InternalProjectPermissionHelper projectPermissionHelper,
 CustomFieldInputHelper customFieldInputHelper)

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.

getSorter

public LuceneFieldSorter getSorter(CustomField customField)

Description copied from interface: SortableCustomFieldSearcher

Returns a LuceneFieldSorter that can be used to sort the values of the custom field.

Specified by:

getSorter in interface SortableCustomFieldSearcher

Parameters:

customField - the custom field to be sorted

Returns:

a LuceneFieldSorter that can be used to load or sort the values of the custom field

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