Package org.broadleafcommerce.core.search.service.solr.index

Class I18nSolrIndexServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

org.broadleafcommerce.core.search.service.solr.index.I18nSolrIndexServiceExtensionHandler

All Implemented Interfaces:

ExtensionHandler, SolrIndexServiceExtensionHandler

@Service("blI18nSolrIndexServiceExtensionHandler")
public class I18nSolrIndexServiceExtensionHandler
extends AbstractSolrIndexServiceExtensionHandler
implements SolrIndexServiceExtensionHandler

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

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field	Description
protected SolrIndexServiceExtensionManager	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	Description
I18nSolrIndexServiceExtensionHandler()

Method Summary

Modifier and Type	Method	Description
protected void	addEntitiesToTranslationCache(List<String> entityIds, TranslatedEntity translatedEntity)
ExtensionResultStatusType	addPropertyValues(Indexable indexable, 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	endBatchEvent(List<? extends Indexable> indexables)	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<? extends Indexable> indexables)	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.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

attachAdditionalBasicFields, attachAdditionalDocumentFields, attachChildDocuments, getCategoryId, getIndexableId, modifyBuiltDocuments, populateDocumentForIndexField

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.common.extension.ExtensionHandler

isEnabled

Methods inherited from interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

attachAdditionalBasicFields, attachAdditionalDocumentFields, attachChildDocuments, getCategoryId, getIndexableId, modifyBuiltDocuments, populateDocumentForIndexField

Field Details

shs

protected SolrHelperService shs

extensionManager

protected SolrIndexServiceExtensionManager extensionManager

translationService

protected TranslationService translationService

localeService

protected LocaleService localeService

Constructor Details

I18nSolrIndexServiceExtensionHandler

public I18nSolrIndexServiceExtensionHandler()

Method Details

getTranslationEnabled

protected boolean getTranslationEnabled()

init

@PostConstruct
public void init()

addPropertyValues

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

Description copied from interface: SolrIndexServiceExtensionHandler

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 SolrIndexServiceExtensionHandler

Overrides:

addPropertyValues in class AbstractSolrIndexServiceExtensionHandler

Returns:

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:

field -

prefixList -

Returns:

startBatchEvent

public ExtensionResultStatusType startBatchEvent(List<? extends Indexable> indexables)

Description copied from interface: SolrIndexServiceExtensionHandler

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.

Specified by:

startBatchEvent in interface SolrIndexServiceExtensionHandler

Overrides:

startBatchEvent in class AbstractSolrIndexServiceExtensionHandler

Returns:

addEntitiesToTranslationCache

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

endBatchEvent

public ExtensionResultStatusType endBatchEvent(List<? extends Indexable> indexables)

Description copied from interface: SolrIndexServiceExtensionHandler

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

Specified by:

endBatchEvent in interface SolrIndexServiceExtensionHandler

Overrides:

endBatchEvent in class AbstractSolrIndexServiceExtensionHandler

Returns:

getPriority

public int getPriority()

Specified by:

getPriority in interface ExtensionHandler

Overrides:

getPriority in class AbstractExtensionHandler