Package com.atlassian.jira.dev.reference.plugin.searchers

Class LabelSearcher

java.lang.Object

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

com.atlassian.jira.dev.reference.plugin.searchers.LabelSearcher

All Implemented Interfaces:

CustomFieldSearcher, FieldSortsCustomFieldSearcher, CustomFieldStattable, IssueSearcher<CustomField>

public class LabelSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, FieldSortsCustomFieldSearcher, CustomFieldStattable

Reference class that implements a custom field searcher - in this case for labels.

Since:

v4.3

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
LabelSearcher(JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper, JiraAuthenticationContext authenticationContext, FieldVisibilityManager fieldVisibilityManager)

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.
void	init(CustomField field)	Initialises the searcher with a given field.

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

LabelSearcher

public LabelSearcher(JqlOperandResolver jqlOperandResolver,
 CustomFieldInputHelper customFieldInputHelper,
 JiraAuthenticationContext authenticationContext,
 FieldVisibilityManager fieldVisibilityManager)

Method Details

init

public void init(CustomField field)

Description copied from interface: IssueSearcher

Initialises the searcher with a given field.

Specified by:

init in interface IssueSearcher<CustomField>

Parameters:

field - the field object. This may be null. (So you can have searchers on non-fields)

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.

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

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