org.broadleafcommerce.core.search.service.solr

Interface SolrSearchServiceExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractSolrSearchServiceExtensionHandler, I18nSolrSearchServiceExtensionHandler

public interface SolrSearchServiceExtensionHandler
extends ExtensionHandler

Author:

Andre Azzolini (apazzolini), bpolster

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	addPropertyValues(Product product, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<Locale> locales) Given the input field, populates the values array with the fields needed for the passed in field.
ExtensionResultStatusType	addPropertyValues(Sku sku, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<Locale> locales) Given the input field, populates the values array with the fields needed for the passed in field.
ExtensionResultStatusType	attachAdditionalBasicFields(Product product, org.apache.solr.common.SolrInputDocument document, SolrHelperService shs) Allows the extension additional fields to the document that are not configured via the DB.
ExtensionResultStatusType	attachAdditionalBasicFields(Sku sku, org.apache.solr.common.SolrInputDocument document, SolrHelperService shs) Allows the extension additional fields to the document that are not configured via the DB.
ExtensionResultStatusType	batchFetchCatalogData(List<Product> products) Batch fetch important collections for the entire list of products in single batch fetch queries.
ExtensionResultStatusType	buildPrefixListForSearchableFacet(Field field, List<String> prefixList) Returns a prefix if required for the passed in facet.
ExtensionResultStatusType	buildPrefixListForSearchableField(Field field, FieldType searchableFieldType, List<String> prefixList) Returns a prefix if required for the passed in searchable field.
ExtensionResultStatusType	endBatchEvent() Perform actions to end a batch event, such as closing any Contexts that have been previously created.
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	getCategoryId(Long category, Long[] returnContainer) In certain scenarios, the requested category id might not be the one that should be used in Solr.
ExtensionResultStatusType	getProductId(Product product, Long[] returnContainer) In certain scenarios, the requested product id might not be the one that should be used in Solr.
ExtensionResultStatusType	getSkuId(Sku sku, Long[] returnContainer) In certain scenarios, the requested sku id might not be the one that should be used in Solr.
ExtensionResultStatusType	getSolrDocumentId(org.apache.solr.common.SolrInputDocument document, Product product, String[] returnContainer) In certain scenarios, we may want to produce a different Solr document id than the default.
ExtensionResultStatusType	getSolrDocumentId(org.apache.solr.common.SolrInputDocument document, Sku sku, String[] returnContainer) In certain scenarios, we may want to produce a different Solr document id than the default.
ExtensionResultStatusType	modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents, List<Product> products, List<Field> fields, List<Locale> locales)
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	startBatchEvent(List<Product> products) Perform actions at the start of a batch to improve performance of Solr search for the list of batch products.

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

getPriority, isEnabled

Method Detail

buildPrefixListForSearchableFacet

ExtensionResultStatusType buildPrefixListForSearchableFacet(Field field,
                                                            List<String> prefixList)

Returns a prefix if required for the passed in facet.

buildPrefixListForSearchableField

ExtensionResultStatusType buildPrefixListForSearchableField(Field field,
                                                            FieldType searchableFieldType,
                                                            List<String> prefixList)

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

filterSearchFacetRanges

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

Builds the search facet ranges for the provided dto.

Parameters:

context -

dto -

ranges -

addPropertyValues

ExtensionResultStatusType addPropertyValues(Product product,
                                            Field field,
                                            FieldType fieldType,
                                            Map<String,Object> values,
                                            String propertyName,
                                            List<Locale> locales)
                                     throws IllegalAccessException,
                                            InvocationTargetException,
                                            NoSuchMethodException

Given the input field, populates the values array with the fields needed for the passed in field. For example, a handler might create multiple fields for the given passed in field.

Parameters:

product -

field -

values -

propertyName -

locales -

Returns:

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

addPropertyValues

ExtensionResultStatusType addPropertyValues(Sku sku,
                                            Field field,
                                            FieldType fieldType,
                                            Map<String,Object> values,
                                            String propertyName,
                                            List<Locale> locales)
                                     throws IllegalAccessException,
                                            InvocationTargetException,
                                            NoSuchMethodException

Given the input field, populates the values array with the fields needed for the passed in field. For example, a handler might create multiple fields for the given passed in field.

Parameters:

sku -

field -

values -

propertyName -

locales -

Returns:

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

modifySolrQuery

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.

Parameters:

context -

query -

qualifiedSolrQuery -

facets -

searchCriteria -

defaultSort - * @return

attachAdditionalBasicFields

ExtensionResultStatusType attachAdditionalBasicFields(Product product,
                                                      org.apache.solr.common.SolrInputDocument document,
                                                      SolrHelperService shs)

Allows the extension additional fields to the document that are not configured via the DB.

attachAdditionalBasicFields

ExtensionResultStatusType attachAdditionalBasicFields(Sku sku,
                                                      org.apache.solr.common.SolrInputDocument document,
                                                      SolrHelperService shs)

Allows the extension additional fields to the document that are not configured via the DB.

getSolrDocumentId

ExtensionResultStatusType getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
                                            Product product,
                                            String[] returnContainer)

In certain scenarios, we may want to produce a different Solr document id than the default. If this method returns ExtensionResultStatusType.HANDLED, the value placed in the 0th element in the returnContainer should be used.

Parameters:

document -

product -

Returns:

the extension result status type

getSolrDocumentId

ExtensionResultStatusType getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
                                            Sku sku,
                                            String[] returnContainer)

In certain scenarios, we may want to produce a different Solr document id than the default. If this method returns ExtensionResultStatusType.HANDLED, the value placed in the 0th element in the returnContainer should be used.

Parameters:

document -

sku -

Returns:

the extension result status type

getCategoryId

ExtensionResultStatusType getCategoryId(Category category,
                                        Long[] returnContainer)

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.

Parameters:

category -

returnContainer -

Returns:

the extension result status type

getCategoryId

ExtensionResultStatusType getCategoryId(Long category,
                                        Long[] returnContainer)

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.

Parameters:

category -

returnContainer -

Returns:

the extension result status type

getProductId

ExtensionResultStatusType getProductId(Product product,
                                       Long[] returnContainer)

In certain scenarios, the requested product 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.

Parameters:

product -

returnContainer -

Returns:

the extension result status type

getSkuId

ExtensionResultStatusType getSkuId(Sku sku,
                                   Long[] returnContainer)

In certain scenarios, the requested sku 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.

Parameters:

sku -

returnContainer -

Returns:

modifyBuiltDocuments

ExtensionResultStatusType modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents,
                                               List<Product> products,
                                               List<Field> fields,
                                               List<Locale> locales)

startBatchEvent

ExtensionResultStatusType startBatchEvent(List<Product> products)

Perform actions at the start of a batch to improve performance of Solr search for the list of batch products. For example we want to get, in bulk, the SkuPriceData for each product and save these in memory by default. This is intended for usage while performing a solr index. For search results and category landing page results, see batchFetchCatalogData(List).

Parameters:

products -

Returns:

endBatchEvent

ExtensionResultStatusType endBatchEvent()

Perform actions to end a batch event, such as closing any Contexts that have been previously created.

Returns:

batchFetchCatalogData

ExtensionResultStatusType batchFetchCatalogData(List<Product> products)

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

Parameters:

products -

Returns: