com.atlassian.confluence.search.v2.lucene.boosting

Interface BoostingQueryFactory

public interface BoostingQueryFactory

You should generally not be using this class directly, use the v2 SearchQuery, BoostingQuery, to remain lucene agnostic.

This service exists as a replacement for constructing lucene BoostingQueries directly.

Since:

5.9

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Query	createLuceneBoostingQuery(org.apache.lucene.search.Query query, BoostingStrategy boostingStrategy) Create a boosting query using the provided boosting strategy.
org.apache.lucene.search.Query	createLuceneBoostingQuery(org.apache.lucene.search.Query query, SearchQueryParameters queryParameters, BoostingStrategy boostingStrategy) Create a boosting query using the provided boosting strategy that is aware of the searchQueryParameters used to generate the query to wrap
org.apache.lucene.search.Query	createLuceneBoostingQueryWithPluggableStrategy(org.apache.lucene.search.Query query) Create a boosting query using the pluggable boosting strategy
org.apache.lucene.search.Query	createLuceneBoostingQueryWithPluggableStrategy(org.apache.lucene.search.Query query, SearchQueryParameters searchQueryParameters) Create a boosting query using the pluggable boosting strategy that is aware of the searchQueryParameters used to generate the query to wrap
BoostingStrategy	getPluggableBoostingStrategy()

Method Detail

createLuceneBoostingQueryWithPluggableStrategy

org.apache.lucene.search.Query createLuceneBoostingQueryWithPluggableStrategy(org.apache.lucene.search.Query query)

Create a boosting query using the pluggable boosting strategy

Parameters:

query - the query to wrap with a boosting query

Returns:

a query boosted by the pluggable boosting strategy

createLuceneBoostingQueryWithPluggableStrategy

org.apache.lucene.search.Query createLuceneBoostingQueryWithPluggableStrategy(org.apache.lucene.search.Query query,
                                                                              SearchQueryParameters searchQueryParameters)

Create a boosting query using the pluggable boosting strategy that is aware of the searchQueryParameters used to generate the query to wrap

Parameters:

query - the query to wrap with a boosting query

Returns:

a query boosted by the pluggable boosting strategy

createLuceneBoostingQuery

org.apache.lucene.search.Query createLuceneBoostingQuery(org.apache.lucene.search.Query query,
                                                         BoostingStrategy boostingStrategy)

Create a boosting query using the provided boosting strategy.

Parameters:

query - the query to wrap with a boosting query

boostingStrategy - the boosting strategy to apply to the wrapped query

Returns:

a query boosted by the given boosting strategy

createLuceneBoostingQuery

org.apache.lucene.search.Query createLuceneBoostingQuery(org.apache.lucene.search.Query query,
                                                         SearchQueryParameters queryParameters,
                                                         BoostingStrategy boostingStrategy)

Create a boosting query using the provided boosting strategy that is aware of the searchQueryParameters used to generate the query to wrap

Parameters:

query - the query to wrap with a boosting query

boostingStrategy - the boosting strategy to apply to the wrapped query

Returns:

a query boosted by the given boosting strategy

getPluggableBoostingStrategy

BoostingStrategy getPluggableBoostingStrategy()

Returns:

the pluggable boosting strategy, this is applied by default in the methods ending with WithPluggableBoostingStrategy