com.broadleafcommerce.dataimport.csv

Class CSVFileImportProcessor

java.lang.Object

com.broadleafcommerce.dataimport.csv.CSVFileImportProcessor

All Implemented Interfaces:

FileImportProcessor

@Service(value="blCSVFileImportProcessor")
public class CSVFileImportProcessor
extends Object
implements FileImportProcessor

Background jobs call this

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected List<BroadleafCellProcessor>	cellProcessors
static String	CONTEXT_HEADERS
protected BroadleafCellProcessor	defaultProcessor
protected org.broadleafcommerce.common.persistence.EntityConfiguration	entityConfiguration
protected DynamicEntityDaoProvider	entityDaoProvider
protected ExternalIdUtil	externalIdUtil
protected List<HeaderNameFilter>	headerNameFilters
protected List<HeaderNameMapper>	headerNameMappers
protected Map<String,String[]>	headerSpecification If the import file does not have a header attached to it, this is a map from ceilingClass -> headers that can serve as the specification in lieu of a first-line header.
protected ImportPersister	importPersister
protected org.springframework.context.MessageSource	messageSource
protected ImportPersister	orderImportPersister
protected com.broadleafcommerce.process.manager.ProcessStateManager	processStateManager

Constructor Summary

Constructors

Constructor and Description
CSVFileImportProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	addValidationDetails(Long processId, org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse response, long recordNumber)
int	calculateTotalRecords(File uploadedFile) Given an InputStream, the implementation should calculate the total number of records to be processed.
boolean	canHandle(File uploadedFile, ImportSpecification importSpecification, ImportType importType) Whether or not this can handle the given input according to the ImportSpecification
protected BroadleafCsvReader	createReader(File file, List<String> ignoredHeaders)
int	getBatchSize()
List<BroadleafCellProcessor>	getCellProcessors()
protected String[]	getHeaders(BroadleafCsvReader reader, ImportType importType)
Map<String,String[]>	getHeaderSpecification()
protected List<String>	getIgnoreHeaderList(ImportContext context)
protected Class<?>	getImplForRequest(Class<?> importingClass, Map<String,ColumnParseResult> row)
protected List<BroadleafCellProcessor>	getProcessorsForHeader(String header, ImportContext context) Returns the first processor representing the header
protected Map<String,List<BroadleafCellProcessor>>	getProcessorsForHeaders(String[] headers, ImportContext context)
boolean	isPrimaryKeyPopulated(Map<String,ColumnParseResult> row, ImportType importType)
RecordParseResult	parseRow(Map<String,ColumnParseResult> row, ImportContext context) Takes an individual row and parses it into a record suitable for writing to the db via the ImportPersister
void	populatePrimaryKeys(List<RowParseResult> rows, ImportType importType) For a given row, this will populate the primary key in the map of processed results.
void	processFile(File uploadedFile, Long processId, ImportContext context) This is designed to process and parse out a given uploadedFile and persist the records to the database.
protected List<RecordParseResult>	readBatch(BroadleafCsvReader reader, int batchSize, Map<String,List<BroadleafCellProcessor>> processors, ImportContext context) Reads in and processes a batch of records.
void	setCellProcessors(List<BroadleafCellProcessor> cellProcessors)
void	setHeaderSpecification(Map<String,String[]> headerSpecification)

Methods inherited from class java.lang.Object

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

Field Detail

cellProcessors

protected List<BroadleafCellProcessor> cellProcessors

defaultProcessor

protected BroadleafCellProcessor defaultProcessor

headerNameMappers

protected List<HeaderNameMapper> headerNameMappers

headerNameFilters

@Autowired(required=false)
protected List<HeaderNameFilter> headerNameFilters

importPersister

protected ImportPersister importPersister

orderImportPersister

protected ImportPersister orderImportPersister

processStateManager

protected com.broadleafcommerce.process.manager.ProcessStateManager processStateManager

entityConfiguration

protected org.broadleafcommerce.common.persistence.EntityConfiguration entityConfiguration

externalIdUtil

protected ExternalIdUtil externalIdUtil

entityDaoProvider

protected DynamicEntityDaoProvider entityDaoProvider

messageSource

protected org.springframework.context.MessageSource messageSource

headerSpecification

protected Map<String,String[]> headerSpecification

If the import file does not have a header attached to it, this is a map from ceilingClass -> headers that can serve as the specification in lieu of a first-line header.

CONTEXT_HEADERS

public static final String CONTEXT_HEADERS

See Also:

Constant Field Values

Constructor Detail

CSVFileImportProcessor

public CSVFileImportProcessor()

Method Detail

canHandle

public boolean canHandle(File uploadedFile,
                         ImportSpecification importSpecification,
                         ImportType importType)

Description copied from interface: FileImportProcessor

Whether or not this can handle the given input according to the ImportSpecification

Specified by:

canHandle in interface FileImportProcessor

Parameters:

uploadedFile - the file that was uploaded by the user

importSpecification - the metadata about uploadedFile in order to determine if it should be processed

Returns:

true if this can handle the given uploadedFile and importSpecification, false otherwise

calculateTotalRecords

public int calculateTotalRecords(File uploadedFile)
                          throws ImportException

Description copied from interface: FileImportProcessor

Given an InputStream, the implementation should calculate the total number of records to be processed.

Specified by:

calculateTotalRecords in interface FileImportProcessor

Returns:

the number of records that will be processed

Throws:

ImportException - if there was a problem in processing the uploadedFile

processFile

public void processFile(File uploadedFile,
                        Long processId,
                        ImportContext context)
                 throws ImportException

Description copied from interface: FileImportProcessor

This is designed to process and parse out a given uploadedFile and persist the records to the database.

Specified by:

processFile in interface FileImportProcessor

Parameters:

uploadedFile - the original file that was uploaded by the user

Throws:

ImportException - if there was a problem in processing the inputStream

addValidationDetails

protected void addValidationDetails(Long processId,
                                    org.broadleafcommerce.openadmin.server.service.persistence.PersistenceResponse response,
                                    long recordNumber)
                             throws ClassNotFoundException

Throws:

ClassNotFoundException

readBatch

protected List<RecordParseResult> readBatch(BroadleafCsvReader reader,
                                            int batchSize,
                                            Map<String,List<BroadleafCellProcessor>> processors,
                                            ImportContext context)
                                     throws IOException

Reads in and processes a batch of records. The number of records that are actually returned could be less than or equal to the given batchSize (like if it is nearing the end of the file).

Throws:

IOException

getHeaders

protected String[] getHeaders(BroadleafCsvReader reader,
                              ImportType importType)
                       throws IOException

Throws:

IOException

parseRow

public RecordParseResult parseRow(Map<String,ColumnParseResult> row,
                                  ImportContext context)

Takes an individual row and parses it into a record suitable for writing to the db via the ImportPersister

isPrimaryKeyPopulated

public boolean isPrimaryKeyPopulated(Map<String,ColumnParseResult> row,
                                     ImportType importType)

populatePrimaryKeys

public void populatePrimaryKeys(List<RowParseResult> rows,
                                ImportType importType)

For a given row, this will populate the primary key in the map of processed results. If the given map was changed OR if the map already contained the primary key. This will denote whether or not the persist request for this row is an ADD or an UPDATE.

This should be done prior to converting rows into a PersistencePackageRequest.

Parameters:

rows -

importType -

getImplForRequest

protected Class<?> getImplForRequest(Class<?> importingClass,
                                     Map<String,ColumnParseResult> row)

getProcessorsForHeaders

protected Map<String,List<BroadleafCellProcessor>> getProcessorsForHeaders(String[] headers,
                                                                           ImportContext context)

createReader

protected BroadleafCsvReader createReader(File file,
                                          List<String> ignoredHeaders)
                                   throws FileNotFoundException

Throws:

FileNotFoundException

getProcessorsForHeader

protected List<BroadleafCellProcessor> getProcessorsForHeader(String header,
                                                              ImportContext context)

Returns the first processor representing the header

Parameters:

header -

context -

Returns:

getIgnoreHeaderList

protected List<String> getIgnoreHeaderList(ImportContext context)

getBatchSize

public int getBatchSize()

getCellProcessors

public List<BroadleafCellProcessor> getCellProcessors()

setCellProcessors

public void setCellProcessors(List<BroadleafCellProcessor> cellProcessors)

getHeaderSpecification

public Map<String,String[]> getHeaderSpecification()

setHeaderSpecification

public void setHeaderSpecification(Map<String,String[]> headerSpecification)