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

Class FunctionScoreQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.FunctionScoreQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

@ExperimentalApi
@SearchPrimitive
public class FunctionScoreQuery
extends Object
implements SearchQuery

v2 primitive query that modifies the wrapped query score of a retrieved document by combining it according to FunctionScoreQuery.BoostMode with an value provided by ScoreFunction.

E.g. Assuming a document has a field page-rank storing a float value and we want to adjust a document score such that a new score will be original text score _score * ln(1 + page-rank), the the query would be

 <@code
  SearchQuery q = new FunctionScoreQuery(new SiteTextSearchQuery("perplexity"),
                 new FieldValueFactorFunction(new FloatFieldValueSource("page-rank"), 1.0, Modifier.LOG1P),
                 FunctionScoreQuery.BoostMode.SUM);
 >

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionScoreQuery.BoostMode

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY

Constructor Summary

Constructors

Constructor	Description
FunctionScoreQuery(SearchQuery wrappedQuery, ScoreFunction function, FunctionScoreQuery.BoostMode boostMode)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SearchQuery	expand()	This primitive but is similar to BooleanQuery, which in some sense primitive but also need to implement expand method, because the wrapped query need to be expanded.
FunctionScoreQuery.BoostMode	getBoostMode()
ScoreFunction	getFunction()
String	getKey()
List	getParameters()	List of parameters as Strings or SearchQuerys.
Stream<SubClause<SearchQuery>>	getSubClauses()	Returns a stream of nested queries.
SearchQuery	getWrappedQuery()
int	hashCode()

Methods inherited from class java.lang.Object

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

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

getBoost

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

FunctionScoreQuery

public FunctionScoreQuery(SearchQuery wrappedQuery,
                          ScoreFunction function,
                          FunctionScoreQuery.BoostMode boostMode)

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.

getBoostMode

public FunctionScoreQuery.BoostMode getBoostMode()

getFunction

public ScoreFunction getFunction()

getWrappedQuery

public SearchQuery getWrappedQuery()

expand

public SearchQuery expand()

This primitive but is similar to BooleanQuery, which in some sense primitive but also need to implement expand method, because the wrapped query need to be expanded.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query

getSubClauses

public Stream<SubClause<SearchQuery>> getSubClauses()

Description copied from interface: SearchQuery

Returns a stream of nested queries.

Specified by:

getSubClauses in interface SearchQuery

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object