com.broadleafcommerce.enterprise.common.extension.search

Interface SolrBoostExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

All Known Implementing Classes:

AbstractSolrBoostExtensionHandler

public interface SolrBoostExtensionHandler
extends org.broadleafcommerce.common.extension.ExtensionHandler

Author:

Nick Crum (ncrum)

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	buildBoostFunction(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> resultHolder, String solrFieldName, BigDecimal boost, Boolean descending, BigDecimal minScore, org.broadleafcommerce.core.search.domain.FieldEntity entityType, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria) Builds the correct boost function for the given parameters and puts it in the result holder
org.broadleafcommerce.common.extension.ExtensionResultStatusType	buildBoostQuery(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> resultHolder, String solrFieldName, String queryString, BigDecimal boost, org.broadleafcommerce.core.search.domain.FieldEntity entityType) Deprecated.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	buildBoostQuery(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> resultHolder, String solrFieldName, String queryString, BigDecimal boost, org.broadleafcommerce.core.search.domain.FieldEntity entityType, org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria) Builds the correct boost query for the given parameters and puts it in the result holder.

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

getPriority, isEnabled

Method Detail

buildBoostQuery

@Deprecated
org.broadleafcommerce.common.extension.ExtensionResultStatusType buildBoostQuery(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> resultHolder,
                                                                                             String solrFieldName,
                                                                                             String queryString,
                                                                                             BigDecimal boost,
                                                                                             org.broadleafcommerce.core.search.domain.FieldEntity entityType)

Deprecated.

Builds the correct boost query for the given parameters and puts it in the result holder.

Parameters:

resultHolder -

solrFieldName - the name of the field we are boosting in Solr (e.g. "device_t")

queryString - the query string for this boost query (e.g. "IPhone", where bq could be "bq=device_t:IPhone")

boost - the boost value for this boost query (e.g. if boost is 2.0, then bq could be "bq=device_t:IPhone^2.0")

entityType -

Returns:

buildBoostQuery

org.broadleafcommerce.common.extension.ExtensionResultStatusType buildBoostQuery(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> resultHolder,
                                                                                 String solrFieldName,
                                                                                 String queryString,
                                                                                 BigDecimal boost,
                                                                                 org.broadleafcommerce.core.search.domain.FieldEntity entityType,
                                                                                 org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)

Builds the correct boost query for the given parameters and puts it in the result holder.

Parameters:

resultHolder -

solrFieldName - the name of the field we are boosting in Solr (e.g. "device_t")

queryString - the query string for this boost query (e.g. "IPhone", where bq could be "bq=device_t:IPhone")

boost - the boost value for this boost query (e.g. if boost is 2.0, then bq could be "bq=device_t:IPhone^2.0")

entityType -

searchCriteria - contains information on the search request such as category and query string

Returns:

buildBoostFunction

org.broadleafcommerce.common.extension.ExtensionResultStatusType buildBoostFunction(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> resultHolder,
                                                                                    String solrFieldName,
                                                                                    BigDecimal boost,
                                                                                    Boolean descending,
                                                                                    BigDecimal minScore,
                                                                                    org.broadleafcommerce.core.search.domain.FieldEntity entityType,
                                                                                    org.broadleafcommerce.core.search.domain.SearchCriteria searchCriteria)

Builds the correct boost function for the given parameters and puts it in the result holder

Parameters:

resultHolder -

solrFieldName -

boost -

descending -

minScore -

entityType -

searchCriteria -

Returns: