de.hybris.platform.commercesearch.search.solrfacetsearch.populators

Class BoostSearchQueryPopulator<FACET_SEARCH_CONFIG_TYPE,INDEXED_TYPE_TYPE,INDEXED_PROPERTY_TYPE,INDEXED_TYPE_SORT_TYPE>

java.lang.Object

de.hybris.platform.commercesearch.search.solrfacetsearch.populators.BoostSearchQueryPopulator<FACET_SEARCH_CONFIG_TYPE,INDEXED_TYPE_TYPE,INDEXED_PROPERTY_TYPE,INDEXED_TYPE_SORT_TYPE>

public class BoostSearchQueryPopulator<FACET_SEARCH_CONFIG_TYPE,INDEXED_TYPE_TYPE,INDEXED_PROPERTY_TYPE,INDEXED_TYPE_SORT_TYPE>
extends Object

This populator adds expressions to the Solr search query that boost certain products to the top of the results. By default so-called hero products are boosted the greatest amount and therefore always appear first in the search results. Since it doesn't normally make sense for boosted products to appear when sorting results by price or name, there is a 'useBoost' option at the Sort level which allows an operator to configure when these Solr boost rules are applied. By default boost rules are only applied when results are sorted by relevance. In addition to hero products, boosts can also be applied to individual indexed properties such as 'inStockFlag', 'brand', 'promotion' etc. Each boost rule is linked to a search profile and indexed property, and will have the following attributes - a comparison operator, a property value and a numeric boost factor to apply. Based on the category that is selected this populator retrieves any hero products/boost rules that are defined and appends the appropriate boost terms to the Solr query via an OR'd expression. The maximum boost value for hero products is defined by setMaxHeroProductBoost(double). For each hero product down the list it will decrement the boost values by the value defined in setHeroProductBoostDecrement(double). This populator should be one of the last populators to kick in.

Constructor Summary

Constructors

Constructor and Description
BoostSearchQueryPopulator()

Method Summary

Modifier and Type	Method and Description
protected void	addBoostQueryTerm(SearchQuery searchQuery, String categoryCode, String fieldName, String fieldValue, double boostFactor) Appends actual boost term to the Solr search query via OR expression.
protected void	addConfiguredProductBoosts(SearchQuery searchQuery, IndexedType indexedType, String categoryCode, FacetSearchConfig facetSearchConfig) Adds boost terms for all configured product boosts in a category.
protected void	addHeroProductBoosts(SearchQuery searchQuery, String categoryCode) Adds boost terms for Hero product boosts.
protected Collection<SolrBoostRuleModel>	getBoostRules(IndexedType indexedType, String categoryCode, FacetSearchConfig facetSearchConfig)
protected String	getCategoryFilterTermKey()
protected String	getSelectedCategory(SearchQueryPageableData<SolrSearchQueryData> source) Returns the selected category as per given SearchQueryPageableData.
protected String	getSort(SearchQueryPageableData<SolrSearchQueryData> source) Return the currently selected sort order.
protected boolean	isBoostDisabled(IndexedTypeSort indexedTypeSort) Checks Sort configuration for useBoost flag.
void	populate(SearchQueryPageableData<SolrSearchQueryData> source, SolrSearchRequest<FACET_SEARCH_CONFIG_TYPE,INDEXED_TYPE_TYPE,INDEXED_PROPERTY_TYPE,SearchQuery,INDEXED_TYPE_SORT_TYPE> target) Add boost expressions as explained in class's JavaDoc.
void	setBoostService(BoostService boostService)
void	setCategoryFilterTermKey(String categoryFilterTermKey) The key in the filter terms (aka facets) that denotes the category.
void	setCategoryService(CategoryService categoryService)
void	setHeroProductBoostDecrement(double heroProductBoostDecrement) The value we subsrtract from the boost value for each hero product down the list.
void	setHeroProductFacade(HeroProductFacade heroProductFacade)
void	setMaxHeroProductBoost(double maxHeroProductBoost) The boost for the hero product on the top position.
void	setSolrQueryOperatorTranslator(SolrQueryOperatorTranslator solrQueryOperatorTranslator)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoostSearchQueryPopulator

public BoostSearchQueryPopulator()

Method Detail

populate

public void populate(SearchQueryPageableData<SolrSearchQueryData> source,
                     SolrSearchRequest<FACET_SEARCH_CONFIG_TYPE,INDEXED_TYPE_TYPE,INDEXED_PROPERTY_TYPE,SearchQuery,INDEXED_TYPE_SORT_TYPE> target)
              throws ConversionException

Add boost expressions as explained in class's JavaDoc.

Throws:

ConversionException

isBoostDisabled

protected boolean isBoostDisabled(IndexedTypeSort indexedTypeSort)

Checks Sort configuration for useBoost flag. This flag controls whether hero and product boosts will be applied for the given indexed type sort. For example results sorted by relevance will typically have this enabled while sorts by price or rating would not.

Parameters:

indexedTypeSort -

Returns:

true if useBoost flag is checked, false otherwise

addHeroProductBoosts

protected void addHeroProductBoosts(SearchQuery searchQuery,
                                    String categoryCode)

Adds boost terms for Hero product boosts. When more than one hero product is configured for a category, the ordering is maintained by decrementing the boost factor between the initial and subsequent hero products.

Parameters:

categoryCode - the category

searchQuery - the searchQuery

addConfiguredProductBoosts

protected void addConfiguredProductBoosts(SearchQuery searchQuery,
                                          IndexedType indexedType,
                                          String categoryCode,
                                          FacetSearchConfig facetSearchConfig)

Adds boost terms for all configured product boosts in a category. The strategy for retrieving boost rules is handled via implementations of BoostService. Supported boost operators are translated into solr query by SolrQueryOperatorTranslator.

Parameters:

searchQuery - the searchQuery

indexedType - the indexedType

categoryCode - the category

facetSearchConfig - the facetSearchConfig

getBoostRules

protected Collection<SolrBoostRuleModel> getBoostRules(IndexedType indexedType,
                                                       String categoryCode,
                                                       FacetSearchConfig facetSearchConfig)

addBoostQueryTerm

protected void addBoostQueryTerm(SearchQuery searchQuery,
                                 String categoryCode,
                                 String fieldName,
                                 String fieldValue,
                                 double boostFactor)

Appends actual boost term to the Solr search query via OR expression.

Parameters:

searchQuery - the SearchQuery

fieldName - the indexed property field to boost

fieldValue - the field value to search for

boostFactor - the boost factor to apply

getSort

protected String getSort(SearchQueryPageableData<SolrSearchQueryData> source)

Return the currently selected sort order. First we look it up in the SearchQueryData that represents the current search state, then we look it up in PageableData that denotes what has been selected by the user on the frontend.

Parameters:

source - the pageable data source

Returns:

the currently selected sort order

getSelectedCategory

protected String getSelectedCategory(SearchQueryPageableData<SolrSearchQueryData> source)

Returns the selected category as per given SearchQueryPageableData. First this method will check if there's a value for a filter term with the key as returned by getCategoryFilterTermKey(). There will be such a value if the user has selected a category facet value. If there is no such filter term this method will return the selected categegory code (i.e. the one the user has clicked on in the top-level navigation.

Parameters:

source - the current search query state

Returns:

the selected category code, either as selected through facets or through top-level navigation

setCategoryFilterTermKey

public void setCategoryFilterTermKey(String categoryFilterTermKey)

The key in the filter terms (aka facets) that denotes the category. We need this to find out if we have selected a given category as a facet value.

setMaxHeroProductBoost

public void setMaxHeroProductBoost(double maxHeroProductBoost)

The boost for the hero product on the top position. Default is 1,000,000.

setHeroProductBoostDecrement

public void setHeroProductBoostDecrement(double heroProductBoostDecrement)

The value we subsrtract from the boost value for each hero product down the list. Default is 5000.

getCategoryFilterTermKey

protected String getCategoryFilterTermKey()

setHeroProductFacade

public void setHeroProductFacade(HeroProductFacade heroProductFacade)

setCategoryService

public void setCategoryService(CategoryService categoryService)

setBoostService

public void setBoostService(BoostService boostService)

setSolrQueryOperatorTranslator

public void setSolrQueryOperatorTranslator(SolrQueryOperatorTranslator solrQueryOperatorTranslator)