Package com.broadleafcommerce.dataexchange.service.catalog.product

Class DefaultOptionTemplatePreloader

java.lang.Object

com.broadleafcommerce.dataexchange.service.catalog.product.DefaultOptionTemplatePreloader

All Implemented Interfaces:

BatchExtensionProcessor, org.springframework.core.Ordered

public class DefaultOptionTemplatePreloader
extends Object
implements BatchExtensionProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultOptionTemplatePreloader.OptionTemplateFilterValues

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPTION_TEMPLATE_GROUPS
static final String	OPTION_TEMPLATES

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DefaultOptionTemplatePreloader(CatalogProvider<ComprehensiveProduct,Variant> catalogProvider, ProductBatchItemHandlerHelper<ComprehensiveProduct> helper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(Class<?> test)	Method to determine if this handler should execute.
protected void	fetchOptionTemplates(DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues, BatchContext<ComprehensiveProduct> batchContext)
protected CatalogProvider<ComprehensiveProduct,Variant>	getCatalogProvider()
protected ProductBatchItemHandlerHelper<ComprehensiveProduct>	getHelper()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	handleCustomGenerateOptionType(ComprehensiveProduct product, GenerateProductOption option, DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues, BatchContext<ComprehensiveProduct> batchContext)
protected void	handleMissingName(ComprehensiveProduct product, GenerateProductOption option, DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues, BatchContext<ComprehensiveProduct> batchContext)
protected boolean	isMissingTemplateName(GenerateProductOption option)
protected void	populateTemplateNames(DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues, List<ComprehensiveProduct> products, BatchContext<ComprehensiveProduct> batchContext)
void	preProcess(BatchContext<?> batch)	This method will be executed to allow customers to fetch, for example, data that is required for future processing.
protected void	validateOptionTemplates(List<ComprehensiveProduct> products, BatchContext<ComprehensiveProduct> batchContext)	Validate the option templates from the request for each product to check that they exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.dataexchange.service.BatchExtensionProcessor

getOrder, postProcess

Field Details

OPTION_TEMPLATES

public static final String OPTION_TEMPLATES

See Also:

• Constant Field Values

OPTION_TEMPLATE_GROUPS

public static final String OPTION_TEMPLATE_GROUPS

See Also:

• Constant Field Values

Constructor Details

DefaultOptionTemplatePreloader

public DefaultOptionTemplatePreloader(CatalogProvider<ComprehensiveProduct,Variant> catalogProvider,
 ProductBatchItemHandlerHelper<ComprehensiveProduct> helper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

canHandle

public boolean canHandle(Class<?> test)

Description copied from interface: BatchExtensionProcessor

Method to determine if this handler should execute.

Specified by:

canHandle in interface BatchExtensionProcessor

Returns:

preProcess

public void preProcess(BatchContext<?> batch)

Description copied from interface: BatchExtensionProcessor

This method will be executed to allow customers to fetch, for example, data that is required for future processing. This is good in situations where you want to pre-fetch or batch fetch and pre-cache data for use within this batch context. Generally, implementors should save any results that they want to save and use later in BatchContext#getAdditionalProperties(). This method is called only if BatchExtensionProcessor.canHandle(Class) returns true. It is executed in AbstractDataExchangeService.saveAll(List, ContextInfo) after AbstractDataExchangeService.split(List, BatchContext) and before AbstractDataExchangeService.aggregate(BatchContext).

Specified by:

preProcess in interface BatchExtensionProcessor

validateOptionTemplates

protected void validateOptionTemplates(List<ComprehensiveProduct> products,
 BatchContext<ComprehensiveProduct> batchContext)

Validate the option templates from the request for each product to check that they exist.

Parameters:

batchContext - the batch context

fetchOptionTemplates

protected void fetchOptionTemplates(DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues,
 BatchContext<ComprehensiveProduct> batchContext)

populateTemplateNames

protected void populateTemplateNames(DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues,
 List<ComprehensiveProduct> products,
 BatchContext<ComprehensiveProduct> batchContext)

handleMissingName

protected void handleMissingName(ComprehensiveProduct product,
 GenerateProductOption option,
 DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues,
 BatchContext<ComprehensiveProduct> batchContext)

handleCustomGenerateOptionType

protected void handleCustomGenerateOptionType(ComprehensiveProduct product,
 GenerateProductOption option,
 DefaultOptionTemplatePreloader.OptionTemplateFilterValues templateFilterValues,
 BatchContext<ComprehensiveProduct> batchContext)

isMissingTemplateName

protected boolean isMissingTemplateName(GenerateProductOption option)

getCatalogProvider

protected CatalogProvider<ComprehensiveProduct,Variant> getCatalogProvider()

getHelper

protected ProductBatchItemHandlerHelper<ComprehensiveProduct> getHelper()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()