com.atlassian.jira.issue.search.searchers.impl
Class QuerySearcher

java.lang.Object
  com.atlassian.jira.issue.search.searchers.impl.AbstractInitializationSearcher
      com.atlassian.jira.issue.search.searchers.impl.QuerySearcher

All Implemented Interfaces:

IssueSearcher<SearchableField>

public class QuerySearcher
extends AbstractInitializationSearcher
implements IssueSearcher<SearchableField>

Field Summary

static String	ID The ID of the query searcher.
static String	QUERY_FIELDS_ID The the key in the FieldValuesHolder that contains a list of fields to search.
static Set<String>	QUERY_JQL_FIELD_NAMES A set of all the JQL clause names that the searcher should recognise.
static Set<String>	QUERY_URL_FIELD_PARAMS The set of URL parameters that deal with field selection.
static String	QUERY_URL_PARAM The URL parameter that actually contains the text to search.

Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractInitializationSearcher

fieldReference

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

log

Constructor Summary

QuerySearcher(VelocityRequestContextFactory velocityRequestContextFactory, com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, FieldVisibilityManager fieldVisibilityManager, JqlOperandResolver operandResolver)

Method Summary

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.

Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractInitializationSearcher

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.search.searchers.IssueSearcher

init

Field Detail

ID

public static final String ID

The ID of the query searcher.

See Also:

Constant Field Values

QUERY_FIELDS_ID

public static final String QUERY_FIELDS_ID

The the key in the FieldValuesHolder that contains a list of fields to search.

See Also:

Constant Field Values

QUERY_JQL_FIELD_NAMES

public static final Set<String> QUERY_JQL_FIELD_NAMES

A set of all the JQL clause names that the searcher should recognise. This inclues clause names for environment, comment, description and summary.

QUERY_URL_FIELD_PARAMS

public static final Set<String> QUERY_URL_FIELD_PARAMS

The set of URL parameters that deal with field selection.

QUERY_URL_PARAM

public static final String QUERY_URL_PARAM

The URL parameter that actually contains the text to search.

See Also:

Constant Field Values

Constructor Detail

QuerySearcher

public QuerySearcher(VelocityRequestContextFactory velocityRequestContextFactory,
                     com.atlassian.velocity.VelocityManager velocityManager,
                     ApplicationProperties applicationProperties,
                     FieldVisibilityManager fieldVisibilityManager,
                     JqlOperandResolver operandResolver)

Method Detail

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.