org.broadleafcommerce.core.search.service.solr

Class AbstractSolrSearchServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

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

All Implemented Interfaces:

ExtensionHandler, SolrSearchServiceExtensionHandler

Direct Known Subclasses:

I18nSolrSearchServiceExtensionHandler

public abstract class AbstractSolrSearchServiceExtensionHandler
extends AbstractExtensionHandler
implements SolrSearchServiceExtensionHandler

Implementors of the SolrSearchServiceExtensionHandler interface should extend this class so that if additional extension points are added which they don't care about, their code will not need to be modified.

Author:

bpolster

Field Summary

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractSolrSearchServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	addAdditionalCategoryIds(Category category, SearchCriteria searchCriteria, List<Long> categoryIds) Adds any additional category ids to filter by when category browsing or searching.
ExtensionResultStatusType	attachFacet(org.apache.solr.client.solrj.SolrQuery query, String indexField, SearchFacetDTO dto) Deprecated. in favor of attachFacet(SolrQuery, String, SearchFacetDTO, SearchCriteria)
ExtensionResultStatusType	attachFacet(org.apache.solr.client.solrj.SolrQuery query, String indexField, SearchFacetDTO dto, SearchCriteria searchCriteria) Attaches the given dto to the given query, if possible
ExtensionResultStatusType	attachSortField(org.apache.solr.client.solrj.SolrQuery solrQuery, String requestedSortFieldName, org.apache.solr.client.solrj.SolrQuery.ORDER order) Attaches the sort field, if able, to the given SolrQuery.
ExtensionResultStatusType	batchFetchCatalogData(List<Product> products) Batch fetch important collections for the entire list of products in single batch fetch queries.
ExtensionResultStatusType	buildActiveFacetFilter(FieldEntity entityType, String solrKey, String[] selectedValues, List<String> valueStrings) Deprecated.
ExtensionResultStatusType	buildActiveFacetFilter(SearchFacet facet, String[] selectedValues, List<String> valueStrings) Builds the active facet filter query string for the given entity type and values.
ExtensionResultStatusType	buildPrefixListForIndexField(IndexField field, FieldType fieldType, List<String> prefixList) Returns a prefix if required for the passed in searchable field.
ExtensionResultStatusType	filterSearchFacetRanges(SearchFacetDTO dto, List<SearchFacetRange> ranges) Builds the search facet ranges for the provided dto.
ExtensionResultStatusType	getCategoryId(Category category, Long[] returnContainer) In certain scenarios, the requested category id might not be the one that should be used in Solr.
ExtensionResultStatusType	getCategorySearchFacets(Category category, List<SearchFacet> searchFacets) Populates the List of SearchFacet's for the given Category, or else returns NOT_HANDLED
ExtensionResultStatusType	getPropertyNameForIndexField(IndexField field, FieldType fieldType, String prefix, ExtensionResultHolder<String> erh) Extension point to allow overriding the way the property name for an index field with the given field type and prefix is built.
ExtensionResultStatusType	getQueryField(org.apache.solr.client.solrj.SolrQuery query, SearchCriteria searchCriteria, IndexFieldType indexFieldType, ExtensionResultHolder<List<String>> queryFieldsResult) Finds and adds the query fields for the given search field and searchable field type.
ExtensionResultStatusType	getSearchableIndexFields(List<IndexField> fields) Populated the List of searchable IndexField's that will be used in building the query fields (qf) for a Solr query.
ExtensionResultStatusType	getSearchFacets(List<SearchFacet> searchFacets) Populates the List of SearchFacet's, or else returns NOT_HANDLED
ExtensionResultStatusType	modifySearchResults(List<org.apache.solr.common.SolrDocument> responseDocuments, List<Product> products) Modifies the product search results from a Solr query
ExtensionResultStatusType	modifySolrQuery(SearchContextDTO context, org.apache.solr.client.solrj.SolrQuery query, String qualifiedSolrQuery, List<SearchFacetDTO> facets, SearchCriteria searchCriteria, String defaultSort) Provides an extension point to modify the SolrQuery.
ExtensionResultStatusType	modifySolrQuery(org.apache.solr.client.solrj.SolrQuery query, String qualifiedSolrQuery, List<SearchFacetDTO> facets, SearchCriteria searchCriteria, String defaultSort) Provides an extension point to modify the SolrQuery.
ExtensionResultStatusType	setFacetResults(Map<String,SearchFacetDTO> namedFacetMap, org.apache.solr.client.solrj.response.QueryResponse response) Attaches any additional facet results to the namedFacetMap if they exist.

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

AbstractSolrSearchServiceExtensionHandler

public AbstractSolrSearchServiceExtensionHandler()

Method Detail

buildPrefixListForIndexField

public ExtensionResultStatusType buildPrefixListForIndexField(IndexField field,
                                                              FieldType fieldType,
                                                              List<String> prefixList)

Description copied from interface: SolrSearchServiceExtensionHandler

Returns a prefix if required for the passed in searchable field.

Specified by:

buildPrefixListForIndexField in interface SolrSearchServiceExtensionHandler

filterSearchFacetRanges

public ExtensionResultStatusType filterSearchFacetRanges(SearchFacetDTO dto,
                                                         List<SearchFacetRange> ranges)

Description copied from interface: SolrSearchServiceExtensionHandler

Builds the search facet ranges for the provided dto.

Specified by:

filterSearchFacetRanges in interface SolrSearchServiceExtensionHandler

modifySolrQuery

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

Description copied from interface: SolrSearchServiceExtensionHandler

Provides an extension point to modify the SolrQuery.

Specified by:

modifySolrQuery in interface SolrSearchServiceExtensionHandler

modifySolrQuery

public ExtensionResultStatusType modifySolrQuery(SearchContextDTO context,
                                                 org.apache.solr.client.solrj.SolrQuery query,
                                                 String qualifiedSolrQuery,
                                                 List<SearchFacetDTO> facets,
                                                 SearchCriteria searchCriteria,
                                                 String defaultSort)

Description copied from interface: SolrSearchServiceExtensionHandler

Provides an extension point to modify the SolrQuery.

Specified by:

modifySolrQuery in interface SolrSearchServiceExtensionHandler

getQueryField

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

Description copied from interface: SolrSearchServiceExtensionHandler

Finds and adds the query fields for the given search field and searchable field type. This method should only ADD to the list within the queryFieldsResult parameters.

Most implementations of this will need to invoke SolrHelperService.getPropertyNameForIndexField(IndexField, FieldType) in order to return the right value to populate in the queryFieldsResult. If the returned result is ExtensionResultStatusType.NOT_HANDLED then the default behavior is to only do that.

Specified by:

getQueryField in interface SolrSearchServiceExtensionHandler

indexFieldType - the field type of the field

queryFieldsResult - the binding result that contains the list of query fields, only add to this @return the result of the handler, if NOT_HANDLED, then no query fields were added

See Also:

SolrHelperService#getPropertyNameForIndexField(IndexField, FieldType)}

modifySearchResults

public ExtensionResultStatusType modifySearchResults(List<org.apache.solr.common.SolrDocument> responseDocuments,
                                                     List<Product> products)

Description copied from interface: SolrSearchServiceExtensionHandler

Modifies the product search results from a Solr query

The parameters passed into this method should be assumed to be sorted identically and match one to one.

Specified by:

modifySearchResults in interface SolrSearchServiceExtensionHandler

Parameters:

responseDocuments - the response documents from Solr

products - the products that tie to the response documents

Returns:

the result of the handler, if NOT_HANDLED, then no changes where made

getSearchFacets

public ExtensionResultStatusType getSearchFacets(List<SearchFacet> searchFacets)

Description copied from interface: SolrSearchServiceExtensionHandler

Populates the List of SearchFacet's, or else returns NOT_HANDLED

Specified by:

getSearchFacets in interface SolrSearchServiceExtensionHandler

Parameters:

searchFacets - the List to populate

Returns:

the result of the handler

attachFacet

@Deprecated
public ExtensionResultStatusType attachFacet(org.apache.solr.client.solrj.SolrQuery query,
                                                         String indexField,
                                                         SearchFacetDTO dto)

Deprecated. in favor of attachFacet(SolrQuery, String, SearchFacetDTO, SearchCriteria)

Description copied from interface: SolrSearchServiceExtensionHandler

Attaches the given dto to the given query, if possible

Specified by:

attachFacet in interface SolrSearchServiceExtensionHandler

Parameters:

query - the SolrQuery to attach the facet to

Returns:

the result of the handler

attachFacet

public ExtensionResultStatusType attachFacet(org.apache.solr.client.solrj.SolrQuery query,
                                             String indexField,
                                             SearchFacetDTO dto,
                                             SearchCriteria searchCriteria)

Description copied from interface: SolrSearchServiceExtensionHandler

Attaches the given dto to the given query, if possible

Specified by:

attachFacet in interface SolrSearchServiceExtensionHandler

Parameters:

query - the SolrQuery to attach the facet to

Returns:

the result of the handler

setFacetResults

public ExtensionResultStatusType setFacetResults(Map<String,SearchFacetDTO> namedFacetMap,
                                                 org.apache.solr.client.solrj.response.QueryResponse response)

Description copied from interface: SolrSearchServiceExtensionHandler

Attaches any additional facet results to the namedFacetMap if they exist. This should only attach facets if they do not already have result DTOs

Specified by:

setFacetResults in interface SolrSearchServiceExtensionHandler

Returns:

the result of the handler

buildActiveFacetFilter

@Deprecated
public ExtensionResultStatusType buildActiveFacetFilter(FieldEntity entityType,
                                                                    String solrKey,
                                                                    String[] selectedValues,
                                                                    List<String> valueStrings)

Deprecated.

Description copied from interface: SolrSearchServiceExtensionHandler

Builds the active facet filter query string for the given entity type and values. Typically this is only used when you are doing faceting on nested child documents.

Specified by:

buildActiveFacetFilter in interface SolrSearchServiceExtensionHandler

Returns:

buildActiveFacetFilter

public ExtensionResultStatusType buildActiveFacetFilter(SearchFacet facet,
                                                        String[] selectedValues,
                                                        List<String> valueStrings)

Description copied from interface: SolrSearchServiceExtensionHandler

Builds the active facet filter query string for the given entity type and values. Typically this is only used when you are doing faceting on nested child documents.

Specified by:

buildActiveFacetFilter in interface SolrSearchServiceExtensionHandler

Returns:

addAdditionalCategoryIds

public ExtensionResultStatusType addAdditionalCategoryIds(Category category,
                                                          SearchCriteria searchCriteria,
                                                          List<Long> categoryIds)

Description copied from interface: SolrSearchServiceExtensionHandler

Adds any additional category ids to filter by when category browsing or searching.

Specified by:

addAdditionalCategoryIds in interface SolrSearchServiceExtensionHandler

Parameters:

category - the current Category we are browsing or searching on

searchCriteria - the criteria for the current query

categoryIds - the category IDs we are going to filter on (this already includes the current category's ID)

Returns:

NOT_HANDLED if no IDs were added, and HANDLED_CONTINUE if there were

getCategorySearchFacets

public ExtensionResultStatusType getCategorySearchFacets(Category category,
                                                         List<SearchFacet> searchFacets)

Description copied from interface: SolrSearchServiceExtensionHandler

Populates the List of SearchFacet's for the given Category, or else returns NOT_HANDLED

Specified by:

getCategorySearchFacets in interface SolrSearchServiceExtensionHandler

Returns:

getSearchableIndexFields

public ExtensionResultStatusType getSearchableIndexFields(List<IndexField> fields)

Description copied from interface: SolrSearchServiceExtensionHandler

Populated the List of searchable IndexField's that will be used in building the query fields (qf) for a Solr query. It is assumed that if the result of this call is NOT_HANDLED, then SolrSearchService will follow it's default behavior for populating IndexFields.

Specified by:

getSearchableIndexFields in interface SolrSearchServiceExtensionHandler

Parameters:

fields - the List to be populated.

Returns:

HANDLED_CONTINUE if it added field, NOT_HANDLED otherwise

getCategoryId

public ExtensionResultStatusType getCategoryId(Category category,
                                               Long[] returnContainer)

Description copied from interface: SolrSearchServiceExtensionHandler

In certain scenarios, the requested category id might not be the one that should be used in Solr. If this method returns ExtensionResultStatusType.HANDLED, the value placed in the 0th element in the returnContainer should be used.

Specified by:

getCategoryId in interface SolrSearchServiceExtensionHandler

Returns:

the extension result status type

batchFetchCatalogData

public ExtensionResultStatusType batchFetchCatalogData(List<Product> products)

Description copied from interface: SolrSearchServiceExtensionHandler

Batch fetch important collections for the entire list of products in single batch fetch queries. In general, this is intended to be used for search results and category landing page results. For batch fetching during solr indexing, see #startBatchEvent(List).

Specified by:

batchFetchCatalogData in interface SolrSearchServiceExtensionHandler

Returns:

attachSortField

public ExtensionResultStatusType attachSortField(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                                 String requestedSortFieldName,
                                                 org.apache.solr.client.solrj.SolrQuery.ORDER order)

Description copied from interface: SolrSearchServiceExtensionHandler

Attaches the sort field, if able, to the given SolrQuery.

Specified by:

attachSortField in interface SolrSearchServiceExtensionHandler

Returns:

getPropertyNameForIndexField

public ExtensionResultStatusType getPropertyNameForIndexField(IndexField field,
                                                              FieldType fieldType,
                                                              String prefix,
                                                              ExtensionResultHolder<String> erh)

Description copied from interface: SolrSearchServiceExtensionHandler

Extension point to allow overriding the way the property name for an index field with the given field type and prefix is built.

Specified by:

getPropertyNameForIndexField in interface SolrSearchServiceExtensionHandler

Returns: