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

Class CustomFieldLabelsSearcher

java.lang.Object

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

com.atlassian.jira.issue.customfields.searchers.CustomFieldLabelsSearcher

All Implemented Interfaces:

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

public class CustomFieldLabelsSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, CustomFieldStattable, NaturallyOrderedCustomFieldSearcher, ValueLoaderCustomFieldSearcher

Searcher for Label custom fields

Since:

v4.2

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
CustomFieldLabelsSearcher(FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver jqlOperandResolver, LabelsClauseValuesGenerator labelsClauseValuesGenerator, JiraAuthenticationContext authenticationContext, 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.
String	getSortField(CustomField customField)	Return the name of the field to use for ordering.
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 customField)	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

CustomFieldLabelsSearcher

public CustomFieldLabelsSearcher(FieldVisibilityManager fieldVisibilityManager,
 JqlOperandResolver jqlOperandResolver,
 LabelsClauseValuesGenerator labelsClauseValuesGenerator,
 JiraAuthenticationContext authenticationContext,
 CustomFieldInputHelper customFieldInputHelper)

Method Details

init

public void init(CustomField customField)

Description copied from interface: IssueSearcher

Initialises the searcher with a given field.

Specified by:

init in interface IssueSearcher<CustomField>

Parameters:

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

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.

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.

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

getSortField

public String getSortField(CustomField customField)

Description copied from interface: NaturallyOrderedCustomFieldSearcher

Return the name of the field to use for ordering. This will normally be just the field, .i.e customField.getId() but some searchers, e.g. TextSearcher, store additional fields to support sorting.

Specified by:

getSortField in interface NaturallyOrderedCustomFieldSearcher

Parameters:

customField - The custom field to be searched

Returns:

The field name to use for ordering.

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