com.atlassian.confluence.search.actions
Class ContentNameSearchAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.search.actions.ContentNameSearchAction

All Implemented Interfaces:

Beanable, WebInterface, ServletRequestAware, Action, LocaleProvider, TextProvider, Validateable, ValidationAware, Serializable

public class ContentNameSearchAction
extends ConfluenceActionSupport
implements Beanable, ServletRequestAware

An action that will take a query String from the front end and apply it as a search across the 'universal title' field within the Confluence search index.

See Also:

Serialized Form

Nested Class Summary

static class	ContentNameSearchAction.ContentNameMatch An individual result from performing the name search.
static class	ContentNameSearchAction.ContentNameSearchResult The result from performing a ContentNameSearch.

Field Summary

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, pluginAccessor, PREVIEW, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

ContentNameSearchAction()

Method Summary

String	execute() Perform the search and create the ContentNameSearchResult.
Object	getBean()
ContentNameSearchAction.ContentNameSearchResult	getResult()
void	setContentNameQueryTokenizer(QueryTokenizer contentNameQueryTokenizer)
void	setContentNameSearcher(ContentNameSearcher contentNameSearcher)
void	setContentNameSearchSemaphoreHolder(SemaphoreHolder contentNameSearchSemaphoreHolder)
void	setContentTypesDisplayMapper(ContentTypesDisplayMapper contentTypesIconMapper)
void	setQuery(String query)
void	setServletRequest(HttpServletRequest httpServletRequest)
void	setSettingsManager(SettingsManager settingsManager)
void	setSpaceKey(String spaceKey)
void	setType(String[] types)

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEventManager, getFriendlyDateFormatter, getGlobalHelper, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSpaceHelper, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermitted, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSpacePermissionManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentNameSearchAction

public ContentNameSearchAction()

Method Detail

execute

public String execute()
               throws Exception

Perform the search and create the ContentNameSearchResult. The individual ContentNameMatch objects within the result will be ordered and grouped, so you can count on getting results ordered like -

• all page matches
• all blog matches
• all attachment matches
• all user matches
• all space matches

If a particular category has no matches then it will not be included in the result.

Specified by:

execute in interface Action

Overrides:

execute in class ActionSupport

Throws:

Exception

setContentTypesDisplayMapper

public void setContentTypesDisplayMapper(ContentTypesDisplayMapper contentTypesIconMapper)

setContentNameSearcher

public void setContentNameSearcher(ContentNameSearcher contentNameSearcher)

setContentNameQueryTokenizer

public void setContentNameQueryTokenizer(QueryTokenizer contentNameQueryTokenizer)

setQuery

public void setQuery(String query)

setType

public void setType(String[] types)

setSpaceKey

public void setSpaceKey(String spaceKey)

getResult

public ContentNameSearchAction.ContentNameSearchResult getResult()

getBean

public Object getBean()

Specified by:

getBean in interface Beanable

Returns:

the result bean (ContentNameSearchResult) on successful execution of this action. If the action has not executed then the return value will be null.

setContentNameSearchSemaphoreHolder

public void setContentNameSearchSemaphoreHolder(SemaphoreHolder contentNameSearchSemaphoreHolder)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

Overrides:

setSettingsManager in class ConfluenceActionSupport

setServletRequest

public void setServletRequest(HttpServletRequest httpServletRequest)

Specified by:

setServletRequest in interface ServletRequestAware