com.broadleafcommerce.enterprise.common.extension.search

Class AbstractSolrBoostExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

com.broadleafcommerce.enterprise.common.extension.search.AbstractSolrBoostExtensionHandler

All Implemented Interfaces:

SolrBoostExtensionHandler, org.broadleafcommerce.common.extension.ExtensionHandler

public abstract class AbstractSolrBoostExtensionHandler
extends org.broadleafcommerce.common.extension.AbstractExtensionHandler
implements SolrBoostExtensionHandler

Author:

Nick Crum (ncrum)

Field Summary

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractSolrBoostExtensionHandler()

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 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.common.extension.ExtensionHandler

getPriority, isEnabled

Constructor Detail

AbstractSolrBoostExtensionHandler

public AbstractSolrBoostExtensionHandler()

Method Detail

buildBoostQuery

@Deprecated
public 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.

Description copied from interface: SolrBoostExtensionHandler

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

Specified by:

buildBoostQuery in interface SolrBoostExtensionHandler

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")

Returns:

buildBoostQuery

public 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)

Description copied from interface: SolrBoostExtensionHandler

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

Specified by:

buildBoostQuery in interface SolrBoostExtensionHandler

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")

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

Returns:

buildBoostFunction

public 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)

Description copied from interface: SolrBoostExtensionHandler

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

Specified by:

buildBoostFunction in interface SolrBoostExtensionHandler

Returns: