com.atlassian.jira.issue.search.managers

Class DefaultIssueSearcherManager

java.lang.Object

com.atlassian.jira.issue.search.managers.DefaultIssueSearcherManager

All Implemented Interfaces:

IssueSearcherManager

public class DefaultIssueSearcherManager
extends Object
implements IssueSearcherManager

Constructor Summary

Constructors

Constructor and Description
DefaultIssueSearcherManager(SearchHandlerManager manager)

Method Summary

Modifier and Type	Method and Description
Collection<IssueSearcher<?>>	getAllSearchers() Return all the active searchers in JIRA.
IssueSearcher<?>	getSearcher(String id) Get a searcher by the searchers name.
Collection<SearcherGroup>	getSearcherGroups() Get all searcher groups.
Collection<SearcherGroup>	getSearcherGroups(SearchContext searchContext) Get all searcher groups with the IssueSearcher that are applicable for the context.
Collection<IssueSearcher<?>>	getSearchers(ApplicationUser searcher, SearchContext context) Get searchers that are applicable for a given context.
void	refresh() Refreshes the IssueSearcher cache

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIssueSearcherManager

public DefaultIssueSearcherManager(SearchHandlerManager manager)

Method Detail

getSearchers

public Collection<IssueSearcher<?>> getSearchers(ApplicationUser searcher,
                                                 SearchContext context)

Description copied from interface: IssueSearcherManager

Get searchers that are applicable for a given context. This is found through the com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchRenderer()#isShown(SearchContext) method.

Specified by:

getSearchers in interface IssueSearcherManager

Parameters:

searcher - that is performing this action.

context - for the list of searchers. Must not be null

Returns:

Collection of IssueSearcher

getAllSearchers

public Collection<IssueSearcher<?>> getAllSearchers()

Description copied from interface: IssueSearcherManager

Return all the active searchers in JIRA. It will not return the searchers unless they are associated with a field.

Specified by:

getAllSearchers in interface IssueSearcherManager

Returns:

all the searchers in JIRA.

getSearcherGroups

public Collection<SearcherGroup> getSearcherGroups(SearchContext searchContext)

Description copied from interface: IssueSearcherManager

Get all searcher groups with the IssueSearcher that are applicable for the context. com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchRenderer()#isShown(SearchContext) method. Note that the SearcherGroup will still appear even if no IssueSearcher are shown for the group.

Specified by:

getSearcherGroups in interface IssueSearcherManager

Parameters:

searchContext - for the searcher groups.

Returns:

Collection of SearcherGroup

getSearcherGroups

public Collection<SearcherGroup> getSearcherGroups()

Description copied from interface: IssueSearcherManager

Get all searcher groups. Note that the SearcherGroup will still appear even if no IssueSearcher are shown for the group.

Specified by:

getSearcherGroups in interface IssueSearcherManager

Returns:

Collection of SearcherGroup

getSearcher

public IssueSearcher<?> getSearcher(String id)

Description copied from interface: IssueSearcherManager

Get a searcher by the searchers name.

Specified by:

getSearcher in interface IssueSearcherManager

Parameters:

id - the string identifier returned by com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchInformation()#getId()

Returns:

the searcher matching the id, null if none is found.

refresh

public void refresh()

Description copied from interface: IssueSearcherManager

Refreshes the IssueSearcher cache

Specified by:

refresh in interface IssueSearcherManager