Package com.atlassian.confluence.search.v2.query

Class SiteTextSearchQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.SiteTextSearchQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

@Internal
public class SiteTextSearchQuery
extends Object
implements SearchQuery

Relocation from confluence-search plugin.

Since:

6.16.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SiteTextSearchQuery.Boost

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY	There is no query mapper registered for this key, which forces the expand() to be called.

Constructor Summary

Constructors

Constructor	Description
SiteTextSearchQuery(String text)
SiteTextSearchQuery(String text, SiteTextSearchQuery.Boost shouldBoost)	Deprecated. since 2.3.11 use new BoostingQuery(new SiteSearchQuery())

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SearchQuery	expand()	Rewrite it into function score query that boosts score by modified date.
String	getKey()
List	getParameters()	List of parameters as Strings or SearchQuerys.
String	getTextQuery()
int	hashCode()
static boolean	isQueryStringSyntax(String queryString)
SiteTextSearchQuery.Boost	shouldBoost()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery

getBoost, getSubClauses

Field Detail

KEY

public static final String KEY

There is no query mapper registered for this key, which forces the expand() to be called. The expand will return an anonymous inner class that has a different key for which there is a mapper. TODO for 8.0: CONFSRVDEV-21036 - split into two queries to make more obvious which one expands and which is primitive

See Also:

Constant Field Values

Constructor Detail

SiteTextSearchQuery

@Deprecated
public SiteTextSearchQuery(String text,
                           SiteTextSearchQuery.Boost shouldBoost)

Deprecated.

since 2.3.11 use new BoostingQuery(new SiteSearchQuery())

SiteTextSearchQuery

public SiteTextSearchQuery(String text)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

getTextQuery

public String getTextQuery()

shouldBoost

public SiteTextSearchQuery.Boost shouldBoost()

isQueryStringSyntax

public static boolean isQueryStringSyntax(String queryString)

expand

public SearchQuery expand()

Rewrite it into function score query that boosts score by modified date. The FunctionScoreQuery wraps a new anonymous inner class that does have a LuceneQueryMapper registered to return the plain textQuery.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object