de.hybris.platform.commercesearch.searchandizing.boost.impl

Class DefaultBoostService

java.lang.Object

de.hybris.platform.commercesearch.searchandizing.boost.impl.DefaultBoostService

All Implemented Interfaces:

BoostService

public class DefaultBoostService
extends Object
implements BoostService

The default implementation for BoostService.

Constructor Summary

Constructors

Constructor and Description
DefaultBoostService()

Method Summary

Modifier and Type	Method and Description
protected Collection<String>	convertIntoCategoryCodes(List<CategoryModel> categories)
protected SolrBoostRuleModel	createBoostRule(AbstractSolrSearchProfileModel searchProfile, SolrFacetSearchConfigModel facetSearchConfig, BoostRuleData boostRuleData)
SolrBoostRuleModel	createBoostRule(IndexedType indexedType, SolrFacetSearchConfigModel facetSearchConfig, String categoryCode, BoostRuleData boostRuleData) Creates and returns a new boost rule based on a given indexed type and facet search config.
protected SolrIndexedPropertyModel	extractSolrIndexedProperty(SolrFacetSearchConfigModel facetSearchConfig, String propertyName)
protected SolrIndexedPropertyModel	findIndexedProperty(String propertyName, List<SolrIndexedPropertyModel> indexedProperties)
AbstractSolrSearchProfileModel	getBoostProfileForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Searches and returns a Solr Search Profile Model which exactly matches or is the nearest to a given category, indexedType and facetSearchConfig.
Collection<SolrBoostRuleModel>	getBoostRulesForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Returns all boost rules for a given category, indexedType and facetSearchConfig.
Collection<SolrBoostRuleModel>	getBoostRulesForGlobalSearchProfile(IndexedType indexedType, FacetSearchConfig facetSearchConfig) Returns all boost rules for a given indexedType and facetSearchConfig that are defined in a GlobalSolrSearchProfile
protected FacetSearchConfig	getConfiguration(SolrFacetSearchConfigModel facetSearchConfig)
protected SolrIndexedTypeModel	getIndexedTypeModel(IndexedType indexedType, FacetSearchConfig facetSearchConfig)
AbstractSolrSearchProfileModel	getProfileForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Searches and returns a Solr Search Profile Model which exactly matches the given category, indexedType and facetSearchConfig.
protected AbstractSolrSearchProfileModel	getSearchProfile(IndexedType indexedType, SolrFacetSearchConfigModel facetSearchConfig, String categoryCode)
void	removeSolrBoostRule(String pk) Shortcut method to remove the SolrBoostRuleModel with the given pk.
void	setCategorySearchProfileMatchStrategy(CategorySolrSearchProfileMatchStrategy categorySearchProfileMatchStrategy)
void	setCategorySearchProfileService(CategorySearchProfileService categorySearchProfileService)
void	setCommerceCategoryService(CommerceCategoryService commerceCategoryService)
void	setFacetSearchConfigDao(FacetSearchConfigDao facetSearchConfigDao)
void	setFacetSearchConfigService(FacetSearchConfigService facetSearchConfigService)
void	setGlobalSearchProfileService(GlobalSearchProfileService globalSearchProfileService)
void	setModelService(ModelService modelService)
void	setSearchProfileDao(SearchProfileDao searchProfileDao)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBoostService

public DefaultBoostService()

Method Detail

getBoostRulesForCategoryAndIndexedType

public Collection<SolrBoostRuleModel> getBoostRulesForCategoryAndIndexedType(IndexedType indexedType,
                                                                             CategoryModel categoryModel,
                                                                             FacetSearchConfig facetSearchConfig)

Description copied from interface: BoostService

Returns all boost rules for a given category, indexedType and facetSearchConfig.

Specified by:

getBoostRulesForCategoryAndIndexedType in interface BoostService

Parameters:

indexedType - The given IndexedType

categoryModel - The given category

facetSearchConfig - The given facetSearchConfig

Returns:

A collection containing all the product boost rules from the nearest matching search profile or empty list when neither category nor global search profiles are found

getBoostRulesForGlobalSearchProfile

public Collection<SolrBoostRuleModel> getBoostRulesForGlobalSearchProfile(IndexedType indexedType,
                                                                          FacetSearchConfig facetSearchConfig)

Description copied from interface: BoostService

Returns all boost rules for a given indexedType and facetSearchConfig that are defined in a GlobalSolrSearchProfile

Specified by:

getBoostRulesForGlobalSearchProfile in interface BoostService

Parameters:

indexedType - The given IndexedType

facetSearchConfig - The given facetSearchConfig

Returns:

A collection containing all the product boost rules from the GlobalSolrSearchProfile or empty list when no global search profiles are found

getBoostProfileForCategoryAndIndexedType

public AbstractSolrSearchProfileModel getBoostProfileForCategoryAndIndexedType(IndexedType indexedType,
                                                                               CategoryModel categoryModel,
                                                                               FacetSearchConfig facetSearchConfig)

Description copied from interface: BoostService

Searches and returns a Solr Search Profile Model which exactly matches or is the nearest to a given category, indexedType and facetSearchConfig.

Specified by:

getBoostProfileForCategoryAndIndexedType in interface BoostService

Parameters:

indexedType - The given indexed type

categoryModel - The given category

facetSearchConfig - The given facet search config

Returns:

a AbstractSolrSearchProfileModel instance which is found.

getProfileForCategoryAndIndexedType

public AbstractSolrSearchProfileModel getProfileForCategoryAndIndexedType(IndexedType indexedType,
                                                                          CategoryModel categoryModel,
                                                                          FacetSearchConfig facetSearchConfig)

Description copied from interface: BoostService

Searches and returns a Solr Search Profile Model which exactly matches the given category, indexedType and facetSearchConfig. If no profile is found, then null is returned.

Specified by:

getProfileForCategoryAndIndexedType in interface BoostService

Parameters:

indexedType - The given indexed type

categoryModel - The given category

facetSearchConfig - The given facet search config

Returns:

a AbstractSolrSearchProfileModel instance which is found or null if no profile is found.

removeSolrBoostRule

public void removeSolrBoostRule(String pk)

Description copied from interface: BoostService

Shortcut method to remove the SolrBoostRuleModel with the given pk.

Specified by:

removeSolrBoostRule in interface BoostService

Parameters:

pk - the pk of the SolrBoostRuleModel which will be removed.

createBoostRule

public SolrBoostRuleModel createBoostRule(IndexedType indexedType,
                                          SolrFacetSearchConfigModel facetSearchConfig,
                                          String categoryCode,
                                          BoostRuleData boostRuleData)

Description copied from interface: BoostService

Creates and returns a new boost rule based on a given indexed type and facet search config. The new boost rule will be assigned to the new or existing search profile.

Specified by:

createBoostRule in interface BoostService

Parameters:

indexedType - The given facet indexed type

facetSearchConfig - The given facet search config

categoryCode - The given category code, if category code is null then the boost rule will be assigned to the global search profile.

boostRuleData - The boostRuleData contains parameter which are needed for boost rule creation (like operatorType, boostFactor, propertyName, propertyValue)

Returns:

Returns a new created SolrBoostRuleModel.

getSearchProfile

protected AbstractSolrSearchProfileModel getSearchProfile(IndexedType indexedType,
                                                          SolrFacetSearchConfigModel facetSearchConfig,
                                                          String categoryCode)

createBoostRule

protected SolrBoostRuleModel createBoostRule(AbstractSolrSearchProfileModel searchProfile,
                                             SolrFacetSearchConfigModel facetSearchConfig,
                                             BoostRuleData boostRuleData)

getConfiguration

protected FacetSearchConfig getConfiguration(SolrFacetSearchConfigModel facetSearchConfig)

extractSolrIndexedProperty

protected SolrIndexedPropertyModel extractSolrIndexedProperty(SolrFacetSearchConfigModel facetSearchConfig,
                                                              String propertyName)

findIndexedProperty

protected SolrIndexedPropertyModel findIndexedProperty(String propertyName,
                                                       List<SolrIndexedPropertyModel> indexedProperties)

convertIntoCategoryCodes

protected Collection<String> convertIntoCategoryCodes(List<CategoryModel> categories)

getIndexedTypeModel

protected SolrIndexedTypeModel getIndexedTypeModel(IndexedType indexedType,
                                                   FacetSearchConfig facetSearchConfig)

setCommerceCategoryService

public void setCommerceCategoryService(CommerceCategoryService commerceCategoryService)

setSearchProfileDao

public void setSearchProfileDao(SearchProfileDao searchProfileDao)

setCategorySearchProfileMatchStrategy

public void setCategorySearchProfileMatchStrategy(CategorySolrSearchProfileMatchStrategy categorySearchProfileMatchStrategy)

setFacetSearchConfigDao

public void setFacetSearchConfigDao(FacetSearchConfigDao facetSearchConfigDao)

setModelService

public void setModelService(ModelService modelService)

setCategorySearchProfileService

public void setCategorySearchProfileService(CategorySearchProfileService categorySearchProfileService)

setGlobalSearchProfileService

public void setGlobalSearchProfileService(GlobalSearchProfileService globalSearchProfileService)

setFacetSearchConfigService

public void setFacetSearchConfigService(FacetSearchConfigService facetSearchConfigService)