com.atlassian.confluence.search.actions

Class SearchQueryBean

java.lang.Object

com.atlassian.confluence.search.actions.SearchQueryBean

All Implemented Interfaces:

Serializable

Deprecated.

since 4.1 - this class has not been part of the recommended search API since 2.9 and should be removed ASAP.

public class SearchQueryBean
extends Object
implements Serializable

Collects query parameters from the search panel (searchpanel.vm) and provides methods that build and return a Query object that lucene can then run.

This class really shouldn't be serializable, but the effort of breaking it up into wired and unwired parts suitable for putting in the session (as it should have been from the beginning) is too much compared to the risk of changing such an old API.

Clients who put the bean into the session are expected to unwire() it on the way out and rewire it on the way back in.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_ALL Deprecated.

Constructor Summary

Constructors

Constructor and Description
SearchQueryBean() Deprecated.
SearchQueryBean(com.atlassian.bonnie.Searcher searcher, SpaceManager spaceManager, UserAccessor userAccessor, LabelManager labelManager, SettingsManager settingsManager) Deprecated.
SearchQueryBean(SearchQueryBean searchQueryBean) Deprecated. Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	addClassSearchField(org.apache.lucene.search.BooleanQuery query, String typeClass) Deprecated.
org.apache.lucene.search.Query	buildPeopleQuery(boolean onlyPeopleWithPersonalSpaces) Deprecated.
org.apache.lucene.search.Query	buildQuery() Deprecated.
org.apache.lucene.search.Query	buildQueryNoSpaceLimit() Deprecated.
org.apache.lucene.search.Query	buildSpaceQuery(String spaceKey) Deprecated. builds a space query without changing the space key of this query bean typically this method will be called in a loop to create queries for a list of space keys
org.apache.lucene.search.Query	buildTypeQuery(String type) Deprecated. builds a type based query without changing the type of this query bean typically this method will be called in a loop to create queries for a list of content types
String	getGroupBy() Deprecated.
String	getIgnoredSearchWords() Deprecated.
String	getLastModified() Deprecated.
String	getQueryString() Deprecated.
String	getSearchWords() Deprecated.
com.atlassian.bonnie.search.SearchWordsLister	getSearchWordsLister() Deprecated.
String	getSpaceKey() Deprecated.
String	getType() Deprecated.
String	getTypeClass() Deprecated.
static String	getTypeClass(String contentType) Deprecated.
boolean	isMailIncluded() Deprecated.
void	setGroupBy(String groupBy) Deprecated.
void	setLabelManager(LabelManager labelManager) Deprecated.
void	setLastModified(String lastModified) Deprecated.
void	setQueryString(String queryString) Deprecated. every time a new query is set we want to reset the search words lister which stores the searched terms and ignored terms.
void	setSearcher(com.atlassian.bonnie.Searcher searcher) Deprecated.
void	setSearchWordsLister(com.atlassian.bonnie.search.SearchWordsLister searchWordsLister) Deprecated.
void	setSettingsManager(SettingsManager settingsManager) Deprecated. Since 5.0
void	setSpaceKey(String spaceKey) Deprecated.
void	setSpaceKeys(List<String> spaceKeys) Deprecated.
void	setSpaceManager(SpaceManager spaceManager) Deprecated.
void	setTimer(Timer timer) Deprecated.
void	setType(String type) Deprecated.
void	setUserAccessor(UserAccessor userAccessor) Deprecated.
String	toString() Deprecated.
void	unwire() Deprecated. Remove all Spring components from the bean, making it safe to transport

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_ALL

public static final String CONTENT_ALL

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SearchQueryBean

public SearchQueryBean()

Deprecated.

SearchQueryBean

public SearchQueryBean(SearchQueryBean searchQueryBean)

Deprecated.

Copy constructor.

Parameters:

searchQueryBean -

SearchQueryBean

public SearchQueryBean(com.atlassian.bonnie.Searcher searcher,
                       SpaceManager spaceManager,
                       UserAccessor userAccessor,
                       LabelManager labelManager,
                       SettingsManager settingsManager)

Deprecated.

Method Detail

unwire

public void unwire()

Deprecated.

Remove all Spring components from the bean, making it safe to transport

getTypeClass

public static String getTypeClass(String contentType)

Deprecated.

buildQuery

public org.apache.lucene.search.Query buildQuery()

Deprecated.

buildQueryNoSpaceLimit

public org.apache.lucene.search.Query buildQueryNoSpaceLimit()

Deprecated.

buildPeopleQuery

public org.apache.lucene.search.Query buildPeopleQuery(boolean onlyPeopleWithPersonalSpaces)

Deprecated.

buildSpaceQuery

public org.apache.lucene.search.Query buildSpaceQuery(String spaceKey)

Deprecated.

builds a space query without changing the space key of this query bean typically this method will be called in a loop to create queries for a list of space keys

Parameters:

spaceKey -

addClassSearchField

public void addClassSearchField(org.apache.lucene.search.BooleanQuery query,
                                String typeClass)

Deprecated.

buildTypeQuery

public org.apache.lucene.search.Query buildTypeQuery(String type)

Deprecated.

builds a type based query without changing the type of this query bean typically this method will be called in a loop to create queries for a list of content types

Parameters:

type -

isMailIncluded

public boolean isMailIncluded()

Deprecated.

getIgnoredSearchWords

public String getIgnoredSearchWords()

Deprecated.

Returns:

a comma separated list of words ignored in the query

getSearchWords

public String getSearchWords()

Deprecated.

getSearchWordsLister

public com.atlassian.bonnie.search.SearchWordsLister getSearchWordsLister()

Deprecated.

setSearchWordsLister

public void setSearchWordsLister(com.atlassian.bonnie.search.SearchWordsLister searchWordsLister)

Deprecated.

getQueryString

public String getQueryString()

Deprecated.

setQueryString

public void setQueryString(String queryString)
                    throws IOException

Deprecated.

every time a new query is set we want to reset the search words lister which stores the searched terms and ignored terms. if we don't the lister will accumulate ignored terms from previous searches

Parameters:

queryString -

Throws:

IOException

getSpaceKey

public String getSpaceKey()

Deprecated.

setSpaceKey

public void setSpaceKey(String spaceKey)

Deprecated.

getGroupBy

public String getGroupBy()

Deprecated.

setGroupBy

public void setGroupBy(String groupBy)

Deprecated.

getType

public String getType()

Deprecated.

setType

public void setType(String type)

Deprecated.

getTypeClass

public String getTypeClass()

Deprecated.

getLastModified

public String getLastModified()

Deprecated.

setLastModified

public void setLastModified(String lastModified)

Deprecated.

setSearcher

public void setSearcher(com.atlassian.bonnie.Searcher searcher)

Deprecated.

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

Deprecated.

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

Deprecated.

setTimer

public void setTimer(Timer timer)

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

setLabelManager

public void setLabelManager(LabelManager labelManager)

Deprecated.

setSpaceKeys

public void setSpaceKeys(List<String> spaceKeys)

Deprecated.

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

Deprecated. Since 5.0