org.broadleafcommerce.core.search.service.solr

Class I18nSolrSearchServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

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

org.broadleafcommerce.core.search.service.solr.I18nSolrSearchServiceExtensionHandler

All Implemented Interfaces:

ExtensionHandler, SolrSearchServiceExtensionHandler

@Service(value="blI18nSolrSearchServiceExtensionHandler")
public class I18nSolrSearchServiceExtensionHandler
extends AbstractSolrSearchServiceExtensionHandler
implements SolrSearchServiceExtensionHandler

If the field is translatable, then this method prefixes the field with supported locales.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected SolrSearchServiceExtensionManager	extensionManager
protected LocaleService	localeService
protected SolrHelperService	shs
protected TranslationService	translationService

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
I18nSolrSearchServiceExtensionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEntitiesToTranslationCache(List<String> entityIds, TranslatedEntity translatedEntity)
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.
protected ExtensionResultStatusType	addPropertyValues(Product product, Sku sku, boolean useSku, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<Locale> locales)
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	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.
protected ExtensionResultStatusType	getLocalePrefix(Field field, List<String> prefixList) If the field is translatable, take the current locale and add that as a prefix.
int	getPriority()
protected boolean	getTranslationEnabled()
void	init()
ExtensionResultStatusType	startBatchEvent(List<Product> products) Read all of the translations for this product batch and their default Skus.

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

attachAdditionalBasicFields, attachAdditionalBasicFields, batchFetchCatalogData, filterSearchFacetRanges, getCategoryId, getCategoryId, getProductId, getSkuId, getSolrDocumentId, getSolrDocumentId, modifyBuiltDocuments, modifySolrQuery

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

attachAdditionalBasicFields, attachAdditionalBasicFields, batchFetchCatalogData, filterSearchFacetRanges, getCategoryId, getCategoryId, getProductId, getSkuId, getSolrDocumentId, getSolrDocumentId, modifyBuiltDocuments, modifySolrQuery

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

isEnabled

Field Detail

shs

protected SolrHelperService shs

extensionManager

protected SolrSearchServiceExtensionManager extensionManager

translationService

protected TranslationService translationService

localeService

protected LocaleService localeService

Constructor Detail

I18nSolrSearchServiceExtensionHandler

public I18nSolrSearchServiceExtensionHandler()

Method Detail

getTranslationEnabled

protected boolean getTranslationEnabled()

init

@PostConstruct
public void init()

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

Overrides:

buildPrefixListForSearchableFacet in class AbstractSolrSearchServiceExtensionHandler

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

Overrides:

buildPrefixListForSearchableField in class AbstractSolrSearchServiceExtensionHandler

addPropertyValues

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

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

Overrides:

addPropertyValues in class AbstractSolrSearchServiceExtensionHandler

Returns:

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

addPropertyValues

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

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

Overrides:

addPropertyValues in class AbstractSolrSearchServiceExtensionHandler

Returns:

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

addPropertyValues

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

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

getLocalePrefix

protected ExtensionResultStatusType getLocalePrefix(Field field,
                                        List<String> prefixList)

If the field is translatable, take the current locale and add that as a prefix.

Parameters:

context -

field -

Returns:

startBatchEvent

public ExtensionResultStatusType startBatchEvent(List<Product> products)

Read all of the translations for this product batch and their default Skus. By reading this up front we save some time by not having to go to the database for each product in each locale

Specified by:

startBatchEvent in interface SolrSearchServiceExtensionHandler

Overrides:

startBatchEvent in class AbstractSolrSearchServiceExtensionHandler

Returns:

addEntitiesToTranslationCache

protected void addEntitiesToTranslationCache(List<String> entityIds,
                                 TranslatedEntity translatedEntity)

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

Overrides:

endBatchEvent in class AbstractSolrSearchServiceExtensionHandler

Returns:

getPriority

public int getPriority()

Specified by:

getPriority in interface ExtensionHandler

Overrides:

getPriority in class AbstractExtensionHandler