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	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 product, 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 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

buildPrefixListForSearchableFacet

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

Description copied from interface: SolrSearchServiceExtensionHandler

Returns a prefix if required for the passed in facet.

Specified by:

buildPrefixListForSearchableFacet in interface SolrSearchServiceExtensionHandler

buildPrefixListForSearchableField

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

Description copied from interface: SolrSearchServiceExtensionHandler

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

Specified by:

buildPrefixListForSearchableField 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

addPropertyValues

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

Description copied from interface: SolrSearchServiceExtensionHandler

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.

Specified by:

addPropertyValues in interface SolrSearchServiceExtensionHandler

Returns:

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

addPropertyValues

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

Description copied from interface: SolrSearchServiceExtensionHandler

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.

Specified by:

addPropertyValues in interface SolrSearchServiceExtensionHandler

Returns:

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

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

defaultSort - * @return

attachAdditionalBasicFields

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

Description copied from interface: SolrSearchServiceExtensionHandler

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

Specified by:

attachAdditionalBasicFields in interface SolrSearchServiceExtensionHandler

attachAdditionalBasicFields

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

Description copied from interface: SolrSearchServiceExtensionHandler

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

Specified by:

attachAdditionalBasicFields in interface SolrSearchServiceExtensionHandler

getSolrDocumentId

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

Description copied from interface: SolrSearchServiceExtensionHandler

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.

Specified by:

getSolrDocumentId in interface SolrSearchServiceExtensionHandler

Returns:

the extension result status type

getSolrDocumentId

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

Description copied from interface: SolrSearchServiceExtensionHandler

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.

Specified by:

getSolrDocumentId in interface SolrSearchServiceExtensionHandler

Returns:

the extension result status type

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

getCategoryId

public ExtensionResultStatusType getCategoryId(Long 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

getProductId

public ExtensionResultStatusType getProductId(Product product,
                                              Long[] returnContainer)

Description copied from interface: SolrSearchServiceExtensionHandler

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.

Specified by:

getProductId in interface SolrSearchServiceExtensionHandler

Returns:

the extension result status type

getSkuId

public ExtensionResultStatusType getSkuId(Sku sku,
                                          Long[] returnContainer)

Description copied from interface: SolrSearchServiceExtensionHandler

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.

Specified by:

getSkuId in interface SolrSearchServiceExtensionHandler

Returns:

modifyBuiltDocuments

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

Specified by:

modifyBuiltDocuments in interface SolrSearchServiceExtensionHandler

startBatchEvent

public ExtensionResultStatusType startBatchEvent(List<Product> products)

Description copied from interface: SolrSearchServiceExtensionHandler

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 SolrSearchServiceExtensionHandler.batchFetchCatalogData(List).

Specified by:

startBatchEvent in interface SolrSearchServiceExtensionHandler

Returns:

endBatchEvent

public ExtensionResultStatusType endBatchEvent()

Description copied from interface: SolrSearchServiceExtensionHandler

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

Specified by:

endBatchEvent in interface SolrSearchServiceExtensionHandler

Returns:

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 SolrSearchServiceExtensionHandler.startBatchEvent(List).

Specified by:

batchFetchCatalogData in interface SolrSearchServiceExtensionHandler

Returns: