com.broadleafcommerce.search.service.extension

Class EditDistanceSolrSearchServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

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

com.broadleafcommerce.search.service.extension.EditDistanceSolrSearchServiceExtensionHandler

All Implemented Interfaces:

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

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

This unique extension handler is used to modify the solr query to add the levenshtein distance for each query term. This was created as a specific extension handler to ensure that the levenshstein distance would be added very last.

Author:

Nick Crum (ncrum)

Field Summary

Fields

Modifier and Type	Field and Description
protected EnterpriseSearchBoostRuleService	boostService
protected org.broadleafcommerce.core.search.service.solr.SolrSearchServiceExtensionManager	extensionManager
protected org.broadleafcommerce.common.config.service.SystemPropertiesService	systemPropertiesService

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
EditDistanceSolrSearchServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
protected boolean	addEditDistanceToQuery(org.apache.solr.client.solrj.SolrQuery query) Helper method that appends the levenshtein distance (edit distance) to the solr query if applicable
int	getPriority()
void	init()
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)

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

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

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

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, getPropertyNameForIndexField, getQueryField, getSearchableIndexFields, getSearchFacets, modifySearchResults, modifySolrQuery, setFacetResults

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

isEnabled

Field Detail

extensionManager

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

boostService

protected EnterpriseSearchBoostRuleService boostService

systemPropertiesService

protected org.broadleafcommerce.common.config.service.SystemPropertiesService systemPropertiesService

Constructor Detail

EditDistanceSolrSearchServiceExtensionHandler

public EditDistanceSolrSearchServiceExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

getPriority

public int getPriority()

Specified by:

getPriority in interface org.broadleafcommerce.common.extension.ExtensionHandler

Overrides:

getPriority in class org.broadleafcommerce.common.extension.AbstractExtensionHandler

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

addEditDistanceToQuery

protected boolean addEditDistanceToQuery(org.apache.solr.client.solrj.SolrQuery query)

Helper method that appends the levenshtein distance (edit distance) to the solr query if applicable

Parameters:

query - the solr query we are modifying

Returns:

true if the levenshtein distance was added, false otherwise