com.broadleafcommerce.search.service.extension

Class EnterpriseSearchSolrSearchServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler

com.broadleafcommerce.search.service.extension.EnterpriseSearchSolrSearchServiceExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.extension.ExtensionHandler, org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

@Service(value="blEnterpriseSearchSolrSearchServiceExtensionHandler")
public class EnterpriseSearchSolrSearchServiceExtensionHandler
extends org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler
implements org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

Author:

Nick Crum (ncrum)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.broadleafcommerce.enterprise.common.extension.search.SolrBoostExtensionManager	boostExtensionManager
protected EnterpriseSearchBoostRuleService	boostService
protected org.broadleafcommerce.common.entity.service.EntityInformationService	entityInfoService
protected org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionManager	extensionManager
protected org.broadleafcommerce.core.search.dao.IndexFieldDao	indexFieldDao
protected org.broadleafcommerce.core.search.service.solr.SolrHelperService	shs

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
EnterpriseSearchSolrSearchServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
protected void	addBoostFunctions(String queryString, List<String> boostFunctions, List<Long> categoryIds, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)
protected void	addBoostQueries(String queryString, List<String> boostQueries, List<Long> categoryIds, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria) Helper method that creates and adds boost queries to the List for CategoryBoostRule's with BoostRuleType.SEARCH_QUERY and BoostRuleType.MATCHING_VALUE, and GlobalBoostRule's with BoostRuleType.MATCHING_VALUE.
protected String	buildBoostFunction(String solrFieldName, BigDecimal boost, Boolean descending, Boolean ordinal, BigDecimal minScore, org.broadleafcommerce.core.search.domain.FieldEntity entityType, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)
protected String	buildBoostQuery(String solrFieldName, String queryString, BigDecimal boost, org.broadleafcommerce.core.search.domain.FieldEntity entityType, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)
protected List<? extends BoostRule>	filterBoostRules(List<? extends BoostRule> boostRules) This method is used to filter out any boost rules that we do not want to apply.
protected CategoryBoostRule	getCategoryBoostRuleForSearch(List<Long> categoryIds)
protected GlobalBoostRule	getGlobalBoostRuleForSearch(org.broadleafcommerce.core.search.domain.IndexFieldType indexFieldType)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getPropertyNameForIndexField(org.broadleafcommerce.core.search.domain.IndexField field, org.broadleafcommerce.core.search.domain.solr.FieldType fieldType, String prefix, org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getQueryField(org.apache.solr.client.solrj.SolrQuery query, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria, org.broadleafcommerce.core.search.domain.IndexFieldType indexFieldType, org.broadleafcommerce.common.extension.ExtensionResultHolder<List<String>> queryFieldsResult)
void	init()
org.broadleafcommerce.common.extension.ExtensionResultStatusType	modifySearchResults(List<org.apache.solr.common.SolrDocument> responseDocuments, List<org.broadleafcommerce.core.catalog.domain.Product> products)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	modifySolrQuery(org.apache.solr.client.solrj.SolrQuery query, String qualifiedSolrQuery, List<org.broadleafcommerce.core.search.domain.SearchFacetDTO> facets, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria, String defaultSort)
protected boolean	shouldSkipBasedOnQuery(String queryString, BoostRule rule)

Methods inherited from class org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler

addAdditionalCategoryIds, attachFacet, attachFacet, attachSortField, batchFetchCatalogData, buildActiveFacetFilter, buildActiveFacetFilter, buildPrefixListForIndexField, filterSearchFacetRanges, getCategoryId, getCategorySearchFacets, getSearchableIndexFields, getSearchFacets, modifySolrQuery, setFacetResults

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

addAdditionalCategoryIds, attachFacet, attachFacet, attachSortField, batchFetchCatalogData, buildActiveFacetFilter, buildActiveFacetFilter, buildPrefixListForIndexField, filterSearchFacetRanges, getCategoryId, getCategorySearchFacets, getSearchableIndexFields, getSearchFacets, modifySolrQuery, setFacetResults

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Field Detail

extensionManager

protected org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionManager extensionManager

boostExtensionManager

protected com.broadleafcommerce.enterprise.common.extension.search.SolrBoostExtensionManager boostExtensionManager

boostService

protected EnterpriseSearchBoostRuleService boostService

shs

protected org.broadleafcommerce.core.search.service.solr.SolrHelperService shs

indexFieldDao

protected org.broadleafcommerce.core.search.dao.IndexFieldDao indexFieldDao

entityInfoService

protected org.broadleafcommerce.common.entity.service.EntityInformationService entityInfoService

Constructor Detail

EnterpriseSearchSolrSearchServiceExtensionHandler

public EnterpriseSearchSolrSearchServiceExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

getQueryField

public org.broadleafcommerce.common.extension.ExtensionResultStatusType getQueryField(org.apache.solr.client.solrj.SolrQuery query,
                                                                                      org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria,
                                                                                      org.broadleafcommerce.core.search.domain.IndexFieldType indexFieldType,
                                                                                      org.broadleafcommerce.common.extension.ExtensionResultHolder<List<String>> queryFieldsResult)

Specified by:

getQueryField in interface org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

Overrides:

getQueryField in class org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler

getGlobalBoostRuleForSearch

protected GlobalBoostRule getGlobalBoostRuleForSearch(org.broadleafcommerce.core.search.domain.IndexFieldType indexFieldType)

getCategoryBoostRuleForSearch

protected CategoryBoostRule getCategoryBoostRuleForSearch(List<Long> categoryIds)

filterBoostRules

protected List<? extends BoostRule> filterBoostRules(List<? extends BoostRule> boostRules)

This method is used to filter out any boost rules that we do not want to apply. When extending this method, note that the first boost rule is chosen for SEARCH_QUERY boosting.

Parameters:

boostRules - a List of BoostRule's (either GlobalBoostRule's or CategoryBoostRule's)

Returns:

a List

modifySearchResults

public org.broadleafcommerce.common.extension.ExtensionResultStatusType modifySearchResults(List<org.apache.solr.common.SolrDocument> responseDocuments,
                                                                                            List<org.broadleafcommerce.core.catalog.domain.Product> products)

Specified by:

modifySearchResults in interface org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

Overrides:

modifySearchResults in class org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler

modifySolrQuery

public org.broadleafcommerce.common.extension.ExtensionResultStatusType modifySolrQuery(org.apache.solr.client.solrj.SolrQuery query,
                                                                                        String qualifiedSolrQuery,
                                                                                        List<org.broadleafcommerce.core.search.domain.SearchFacetDTO> facets,
                                                                                        org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria,
                                                                                        String defaultSort)

Specified by:

modifySolrQuery in interface org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

Overrides:

modifySolrQuery in class org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler

addBoostQueries

protected void addBoostQueries(String queryString,
                               List<String> boostQueries,
                               List<Long> categoryIds,
                               org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)

Helper method that creates and adds boost queries to the List for CategoryBoostRule's with BoostRuleType.SEARCH_QUERY and BoostRuleType.MATCHING_VALUE, and GlobalBoostRule's with BoostRuleType.MATCHING_VALUE. This is used for boosting specific fields within a category, and fields that match a value globally or categorically.

Parameters:

queryString -

boostQueries -

categoryIds -

searchCriteria -

addBoostFunctions

protected void addBoostFunctions(String queryString,
                                 List<String> boostFunctions,
                                 List<Long> categoryIds,
                                 org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)

shouldSkipBasedOnQuery

protected boolean shouldSkipBasedOnQuery(String queryString,
                                         BoostRule rule)

buildBoostFunction

protected String buildBoostFunction(String solrFieldName,
                                    BigDecimal boost,
                                    Boolean descending,
                                    Boolean ordinal,
                                    BigDecimal minScore,
                                    org.broadleafcommerce.core.search.domain.FieldEntity entityType,
                                    org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)

buildBoostQuery

protected String buildBoostQuery(String solrFieldName,
                                 String queryString,
                                 BigDecimal boost,
                                 org.broadleafcommerce.core.search.domain.FieldEntity entityType,
                                 org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)

getPropertyNameForIndexField

public org.broadleafcommerce.common.extension.ExtensionResultStatusType getPropertyNameForIndexField(org.broadleafcommerce.core.search.domain.IndexField field,
                                                                                                     org.broadleafcommerce.core.search.domain.solr.FieldType fieldType,
                                                                                                     String prefix,
                                                                                                     org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh)

Specified by:

getPropertyNameForIndexField in interface org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionHandler

Overrides:

getPropertyNameForIndexField in class org.broadleafcommerce.core.search.service.solr.AbstractSolrSearchServiceExtensionHandler