com.broadleafcommerce.datafeed.generator

Class AbstractDataFeedGenerator<T>

java.lang.Object

com.broadleafcommerce.datafeed.generator.AbstractDataFeedGenerator<T>

Type Parameters:

T - The type of Entity being generated.

All Implemented Interfaces:

DataFeedGenerator<T>

Direct Known Subclasses:

AbstractFullDataFeedGenerator, AbstractStreamingDataFeedGenerator

public abstract class AbstractDataFeedGenerator<T>
extends Object
implements DataFeedGenerator<T>

This class provides most methods needed to implement a data feed for a single entity

Author:

- BLC

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	LOG
protected List<DataFeedFieldProcessor>	processors
protected List<DataFeedPublisher>	publishers

Constructor Summary

Constructors

Constructor and Description
AbstractDataFeedGenerator()

Method Summary

Modifier and Type	Method and Description
protected DataFeedOutputField	buildDataFeedGraph(DataFeed dataFeed)
protected org.apache.commons.beanutils.BasicDynaClass	buildDynamicClass(DataFeedOutputField graph)
protected boolean	checkConditionallyRequired(String rule, org.apache.commons.beanutils.DynaBean dynamicEntity)
protected abstract void	findAndProcessData(DataFeed dataFeed, DataFeedPublisher publisher) Finds the data needed for this data feed and processes it by building the feed format and publishing to the passed in publisher.
void	generate(DataFeed dataFeed) Primary method used to generate a DataFeed.
protected org.apache.commons.beanutils.DynaBean	getDynamicEntity(Map<T,org.apache.commons.beanutils.DynaBean> feedItems, T entity, org.apache.commons.beanutils.BasicDynaClass custom)
protected DataFeedPublisher	identifyDataFeedPublisher(DataFeed dataFeed)
protected org.apache.commons.beanutils.DynaBean	initializeDynamicClass(org.apache.commons.beanutils.DynaClass custom)
protected Long	lookupTestCount(DataFeed dataFeed)
protected List<Long>	lookupTestIds(DataFeed dataFeed)
protected Map<T,String>	resolveValues(List<T> entities, DataFeedField dataFeedField)
protected boolean	shouldExcludeField(DataFeedField field, String value, boolean valueIsValid)
DataFeedDynamicList	translateEntityListToDynamicList(DataFeed dataFeed, List<T> entities) Required template method for implementations that leverage the AbstractDataFeedGenerator classes.
protected boolean	validateValue(String value, DataFeedField dataFeedField, org.apache.commons.beanutils.DynaBean dynamicEntity)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.datafeed.generator.DataFeedGenerator

canGenerateForEntityType

Field Detail

LOG

protected final org.apache.commons.logging.Log LOG

publishers

@Autowired
protected List<DataFeedPublisher> publishers

processors

@Autowired
protected List<DataFeedFieldProcessor> processors

Constructor Detail

AbstractDataFeedGenerator

public AbstractDataFeedGenerator()

Method Detail

generate

public void generate(DataFeed dataFeed)
              throws InvalidItemException,
                     DataFeedException

Description copied from interface: DataFeedGenerator

Primary method used to generate a DataFeed. It will be generated and then published to the location specified in the feed values.

Specified by:

generate in interface DataFeedGenerator<T>

Throws:

InvalidItemException

DataFeedException

findAndProcessData

protected abstract void findAndProcessData(DataFeed dataFeed,
                                           DataFeedPublisher publisher)
                                    throws InvalidItemException,
                                           DataFeedException

Finds the data needed for this data feed and processes it by building the feed format and publishing to the passed in publisher.

Parameters:

dataFeed -

publisher -

Throws:

InvalidItemException

DataFeedException

translateEntityListToDynamicList

public DataFeedDynamicList translateEntityListToDynamicList(DataFeed dataFeed,
                                                            List<T> entities)
                                                     throws DataFeedException

Description copied from interface: DataFeedGenerator

Required template method for implementations that leverage the AbstractDataFeedGenerator classes. Processes a set of entities (e.g. SKU, Product, etc.) and converts them into a format used by the publishers.

Specified by:

translateEntityListToDynamicList in interface DataFeedGenerator<T>

Returns:

Throws:

DataFeedException

identifyDataFeedPublisher

protected DataFeedPublisher identifyDataFeedPublisher(DataFeed dataFeed)
                                               throws DataFeedException

Throws:

DataFeedException

getDynamicEntity

protected org.apache.commons.beanutils.DynaBean getDynamicEntity(Map<T,org.apache.commons.beanutils.DynaBean> feedItems,
                                                                 T entity,
                                                                 org.apache.commons.beanutils.BasicDynaClass custom)
                                                          throws InstantiationException,
                                                                 IllegalAccessException

Throws:

InstantiationException

IllegalAccessException

validateValue

protected boolean validateValue(String value,
                                DataFeedField dataFeedField,
                                org.apache.commons.beanutils.DynaBean dynamicEntity)
                         throws InvalidItemException

Throws:

InvalidItemException

shouldExcludeField

protected boolean shouldExcludeField(DataFeedField field,
                                     String value,
                                     boolean valueIsValid)

checkConditionallyRequired

protected boolean checkConditionallyRequired(String rule,
                                             org.apache.commons.beanutils.DynaBean dynamicEntity)

resolveValues

protected Map<T,String> resolveValues(List<T> entities,
                                      DataFeedField dataFeedField)

initializeDynamicClass

protected org.apache.commons.beanutils.DynaBean initializeDynamicClass(org.apache.commons.beanutils.DynaClass custom)
                                                                throws InstantiationException,
                                                                       IllegalAccessException

Throws:

InstantiationException

IllegalAccessException

buildDataFeedGraph

protected DataFeedOutputField buildDataFeedGraph(DataFeed dataFeed)

buildDynamicClass

protected org.apache.commons.beanutils.BasicDynaClass buildDynamicClass(DataFeedOutputField graph)

lookupTestCount

protected Long lookupTestCount(DataFeed dataFeed)

lookupTestIds

protected List<Long> lookupTestIds(DataFeed dataFeed)