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

Class TextSearcher

java.lang.Object

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

com.atlassian.jira.issue.customfields.searchers.TextSearcher

All Implemented Interfaces:

CustomFieldSearcher, NaturallyOrderedCustomFieldSearcher, IssueSearcher<CustomField>

@PublicSpi
@PublicApi
public class TextSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, NaturallyOrderedCustomFieldSearcher

A free-text custom field searcher

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
TextSearcher(FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper)
TextSearcher(FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper, IndexingFeatures indexingFeatures)

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

TextSearcher

public TextSearcher(FieldVisibilityManager fieldVisibilityManager,
 JqlOperandResolver jqlOperandResolver,
 CustomFieldInputHelper customFieldInputHelper)

TextSearcher

public TextSearcher(FieldVisibilityManager fieldVisibilityManager,
 JqlOperandResolver jqlOperandResolver,
 CustomFieldInputHelper customFieldInputHelper,
 IndexingFeatures indexingFeatures)

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.

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.