@PublicSpi @PublicApi public class

TextSearcher

extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher NaturallyOrderedCustomFieldSearcher
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
     ↳ com.atlassian.jira.issue.customfields.searchers.TextSearcher

@PublicSpi

This class is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A free-text custom field searcher

Summary

[Expand]
Inherited Fields
From interface com.atlassian.jira.issue.search.searchers.IssueSearcher
Public Constructors
TextSearcher(FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper)
Public Methods
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)
Retrun the name of the Lucene field to use for ordering.
@Deprecated LuceneFieldSorter getSorter(CustomField customField)
Deprecated since 5.1 this field supports natural orderring.
void init(CustomField field)
This is the first time the searcher knows what its ID and names are
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
From class java.lang.Object
From interface com.atlassian.jira.issue.customfields.CustomFieldSearcher
From interface com.atlassian.jira.issue.customfields.NaturallyOrderedCustomFieldSearcher
From interface com.atlassian.jira.issue.search.searchers.IssueSearcher

Public Constructors

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

Public Methods

public CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler ()

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

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

public SearcherInformation<CustomField> getSearchInformation ()

Provides an object that contains information about the Searcher.

Returns
  • the search information provider for this searcher.

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

Returns
  • the search input handler for this searcher.

public SearchRenderer getSearchRenderer ()

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.

Returns
  • the search renderer for this searcher.

public String getSortField (CustomField customField)

Retrun the name of the Lucene 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.

Parameters
customField The custom field to be searched
Returns
  • The Lucene field name to use for ordering.

@Deprecated public LuceneFieldSorter getSorter (CustomField customField)

Deprecated since 5.1 this field supports natural orderring.

public void init (CustomField field)

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

Parameters
field the Custom Field for this searcher