com.broadleafcommerce.datafeed.generator

Interface DataFeedGenerator<T>

All Known Subinterfaces:

StreamingDataFeedGenerator<T>

All Known Implementing Classes:

AbstractDataFeedGenerator, AbstractFullDataFeedGenerator, AbstractStreamingDataFeedGenerator, InventoryDataFeedGenerator, SkuDataFeedGenerator

public interface DataFeedGenerator<T>

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateForEntityType(DataFeedEntityType entityType) Returns true if this generator is able to process the passed in entityType.
void	generate(DataFeed dataFeed) Primary method used to generate a DataFeed.
DataFeedDynamicList	translateEntityListToDynamicList(DataFeed dataFeed, List<T> entities) Required template method for implementations that leverage the AbstractDataFeedGenerator classes.

Method Detail

canGenerateForEntityType

boolean canGenerateForEntityType(DataFeedEntityType entityType)

Returns true if this generator is able to process the passed in entityType.

generate

void generate(DataFeed dataFeed)
       throws InvalidItemException,
              DataFeedException

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

Parameters:

dataFeed -

Throws:

InvalidItemException

DataFeedException

translateEntityListToDynamicList

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

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.

Parameters:

dataFeed -

entities -

Returns:

Throws:

DataFeedException