com.broadleafcommerce.dataimport.csv.cellprocessor

Interface BroadleafCellProcessor

All Known Implementing Classes:

BroadleafCellProcessorAdaptor, CategoryRelationshipCellProcessor, CustomerAddressCellProcessor, CustomerAttributesCellProcessor, CustomerCellProcessor, DefaultParentCategoryCellProcessor, MediaParsingCellProcessor, OrderLineCellProcessor, PassthroughCellProcessor, ProductCategoryCellProcessor, ProductDefaultCategoryCellProcessor, ProductPrimaryImageCellProcessor, ProductRelationshipCellProcessor, SingleAttributeCellProcessor, SingleMediaProcessor

public interface BroadleafCellProcessor

A processor that applies to a particular header within a particular class. For instance, there might be a value for 'category' column in the CSV file that needs to do a lookup on existing categories

Author:

Elbert Bautista (elbertbautista), Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(String header, ImportType importType) Determines if this processor can be used to handle the given header within the context of an import of the given importingClass
ColumnParseResult	execute(String value, BroadleafCsvContext context) Parses out the String value that appears in the CSV file.

Method Detail

canHandle

boolean canHandle(String header,
                  ImportType importType)

Determines if this processor can be used to handle the given header within the context of an import of the given importingClass

Parameters:

header - the header that appears in the CSV

importType - the type of import

Returns:

true if this can process the header, false otherwise.

execute

@Nonnull
ColumnParseResult execute(@Nullable
                                   String value,
                                   BroadleafCsvContext context)

Parses out the String value that appears in the CSV file. This should never return null and instead should always return a valid instance of ColumnParseResult. The ColumnParseResult.getVal() could be null.

Parameters:

value - the raw value that was parsed out of the CSV row, could be null if the value was ommitted

context - the context that the value appears in in relation to the rest of the line

Returns:

a new ColumnParseResult indicating either the parsed value or sub-persistence packages that should be executed