Package com.atlassian.jira.issue.search.searchers.impl

Class DescriptionQuerySearcher

java.lang.Object

com.atlassian.jira.issue.search.searchers.impl.DescriptionQuerySearcher

All Implemented Interfaces:

IssueSearcher<SearchableField>

public class DescriptionQuerySearcher
extends Object
implements IssueSearcher<SearchableField>

Searcher for the Description field. This maps to the LHS of JQL query "description ~ foo".

Since:

v5.2

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
DescriptionQuerySearcher(JqlOperandResolver operandResolver, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, FieldVisibilityManager fieldVisibilityManager)

Method Summary

Modifier and Type	Method	Description
SearcherInformation<SearchableField>	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.
void	init(SearchableField field)	Initialises the searcher with a given field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DescriptionQuerySearcher

public DescriptionQuerySearcher(JqlOperandResolver operandResolver,
 VelocityRequestContextFactory velocityRequestContextFactory,
 ApplicationProperties applicationProperties,
 VelocityTemplatingEngine templatingEngine,
 FieldVisibilityManager fieldVisibilityManager)

Method Details

init

public void init(SearchableField field)

Description copied from interface: IssueSearcher

Initialises the searcher with a given field.

Specified by:

init in interface IssueSearcher<SearchableField>

Parameters:

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

getSearchInformation

public SearcherInformation<SearchableField> getSearchInformation()

Description copied from interface: IssueSearcher

Provides an object that contains information about the Searcher.

Specified by:

getSearchInformation in interface IssueSearcher<SearchableField>

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

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

Returns:

the search renderer for this searcher.