com.atlassian.confluence.search.contentnames

Class DefaultContentNameSearchService

java.lang.Object

com.atlassian.confluence.search.contentnames.DefaultContentNameSearchService

All Implemented Interfaces:

ContentNameSearchService

public class DefaultContentNameSearchService
extends Object
implements ContentNameSearchService

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH_FOR_CSS_CLASS

Fields inherited from interface com.atlassian.confluence.search.contentnames.ContentNameSearchService

DEFAULT_MAX_RESULTS_PER_CATEGORY, DEFAULT_TOTAL_MAX_RESULTS

Constructor Summary

Constructors

Constructor and Description
DefaultContentNameSearchService(SettingsManager settingsManager, I18NBeanFactory i18NBeanFactory, QueryTokenizer contentNameQueryTokenizer, SemaphoreHolder contentNameSearchSemaphoreHolder, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method and Description
ContentNameSearchResult	search(String query, ContentNameSearchContext context) This performs a content name search in Confluence and returns the results.
ContentNameSearchResult	search(String query, Iterable<String> types, String spaceKey, int maxPerCategory, javax.servlet.http.HttpServletRequest httpServletRequest) This performs a content name search in Confluence and returns the results.

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_FOR_CSS_CLASS

public static final String SEARCH_FOR_CSS_CLASS

See Also:

Constant Field Values

Constructor Detail

DefaultContentNameSearchService

public DefaultContentNameSearchService(SettingsManager settingsManager,
                                       I18NBeanFactory i18NBeanFactory,
                                       QueryTokenizer contentNameQueryTokenizer,
                                       SemaphoreHolder contentNameSearchSemaphoreHolder,
                                       com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

search

public ContentNameSearchResult search(String query,
                                      Iterable<String> types,
                                      String spaceKey,
                                      int maxPerCategory,
                                      javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ContentNameSearchService

This performs a content name search in Confluence and returns the results.

Specified by:

search in interface ContentNameSearchService

Parameters:

query - The text that the user wishes to search for.

types - Uses the default "types" (Search Categories) if nothing is provided, otherwise returns different Categories than the default.

spaceKey - You can restrict your search to a particular space if provided. By default it searches all of Confluence.

maxPerCategory - If maxPerCategory is -1 then it returns the default maximum amount, otherwise it returns the positive number provided.

Returns:

The search results. Errors are also encapsulated in the returned object, null should NOT be returned.

search

public ContentNameSearchResult search(String query,
                                      ContentNameSearchContext context)

Description copied from interface: ContentNameSearchService

This performs a content name search in Confluence and returns the results.

Specified by:

search in interface ContentNameSearchService

Parameters:

query - The text that the user wishes to search for.

context - The search context to be used in order to carry the search request

Returns:

The search results. Errors are also encapsulated in the returned object, null should NOT be returned.