Package com.broadleafcommerce.dataimport.service

Class CSVErrorsReportService

java.lang.Object

com.broadleafcommerce.dataimport.service.CSVErrorsReportService

All Implemented Interfaces:

ErrorsReportService

public class CSVErrorsReportService
extends Object
implements ErrorsReportService

Retrieves or generates the new import error report in "csv" format.

Author:

Dima Myroniuk (dmyroniuk), Phillip Verheyden

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CSVErrorsReportService.AutoCloseableCsvWriter	Wrapper of CsvWriter that implements AutoCloseable for use in try-with-resources statements.

Constructor Summary

Constructors

Constructor	Description
CSVErrorsReportService(ImportService<Import> importService, StorageService storage, BatchItemCompletionService<BatchItemCompletion> batchItemCompletionService, ImportManager importManager)

Method Summary

Modifier and Type	Method	Description
protected CSVErrorsReportService.AutoCloseableCsvWriter	buildCsvWriter(File file)
protected com.univocity.parsers.csv.CsvWriterSettings	buildCsvWriterSettings()
Optional<org.springframework.core.io.Resource>	getErrorsReport(String importId)	Note that the use of Transactional is intentional - a transaction is required to keep the connection open for the entire read of the BatchItemCompletionService.readAllByImportIdAndStatus(String, String) stream.
protected String[]	getHeadersFromOriginalFile(InputStream originalFile)
protected LinkedHashSet<String>	getHeadersToWrite(InputStream originalFile, Map<String,String> propertyNameToHeaderName)
protected ImportSpecificationService	getImportSpecificationService()
protected Map<String,String>	getRowWithAdditionalDataAdded(BatchItemCompletion batchItemCompletion, Map<String,String> propertyNameToHeaderName, ImportSpecification specification)	Takes the original row from batchItemCompletion and returns a new row with mutations and additional entries as necessary.
protected Map<String,String>	getSpecificationNameMap(ImportSpecification spec)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isEligibleForErrorsDownload(Import metadata)	A simple method that examines the given metadata object to determine whether an errors report can be created for it.
void	setErrorMessageHeader(String errorMessageHeader)	Header in the error download that maps to the error that occurred with the record
void	setImportSpecificationService(ImportSpecificationService importSpecificationService)
void	setLineNumberHeader(String lineNumberHeader)	Header in the error download that maps back to the line number in the original file

Methods inherited from class java.lang.Object

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

Constructor Details

CSVErrorsReportService

public CSVErrorsReportService(ImportService<Import> importService,
 StorageService storage,
 BatchItemCompletionService<BatchItemCompletion> batchItemCompletionService,
 ImportManager importManager)

Method Details

getErrorsReport

@Transactional("importTransactionManager")
public Optional<org.springframework.core.io.Resource> getErrorsReport(String importId)

Note that the use of Transactional is intentional - a transaction is required to keep the connection open for the entire read of the BatchItemCompletionService.readAllByImportIdAndStatus(String, String) stream.

Specified by:

getErrorsReport in interface ErrorsReportService

Parameters:

importId - the id of the import

Returns:

the resource, or an empty optional if an errors report cannot be generated for the given import (either because the result of isEligibleForErrorsDownload(Import) is false, or if there are no errors to build the report from)

See Also:

• ErrorsReportService.isEligibleForErrorsDownload(Import)

isEligibleForErrorsDownload

public boolean isEligibleForErrorsDownload(Import metadata)

Description copied from interface: ErrorsReportService

A simple method that examines the given metadata object to determine whether an errors report can be created for it.

The default implementation is simply to check that the import has a non-zero errors count and has a finished Import.status.

Specified by:

isEligibleForErrorsDownload in interface ErrorsReportService

Parameters:

metadata - the import which should be checked for errors report eligibility

Returns:

true if an errors report can be generated for the given import, false otherwise

See Also:

• ErrorsReportService.getErrorsReport(String)

getHeadersToWrite

protected LinkedHashSet<String> getHeadersToWrite(InputStream originalFile,
 Map<String,String> propertyNameToHeaderName)

getHeadersFromOriginalFile

protected String[] getHeadersFromOriginalFile(InputStream originalFile)
                                       throws IOException

Throws:

IOException

getRowWithAdditionalDataAdded

protected Map<String,String> getRowWithAdditionalDataAdded(BatchItemCompletion batchItemCompletion,
 Map<String,String> propertyNameToHeaderName,
 ImportSpecification specification)

Takes the original row from batchItemCompletion and returns a new row with mutations and additional entries as necessary. For example, this will map back from field names to header names, as well as add additional entries for columns like DefaultImportProcessor.OPERATION_COLUMN for use in subsequent imports of the errors file.

Parameters:

batchItemCompletion - the batch item completion whose row should be processed

propertyNameToHeaderName - a pre-processed map containing mappings from property names to header names

specification - the specification, useful for obtaining additional data as needed

Returns:

a new, mutated copy of the original row

getSpecificationNameMap

@Deprecated(since="1.8.1",
            forRemoval=true)
protected Map<String,String> getSpecificationNameMap(ImportSpecification spec)

Deprecated, for removal: This API element is subject to removal in a future version.

This method has been deprecated, and will be removed when ImportSpecification.getFieldConfigMap() is removed. Specifications should move to using ImportSpecification.getHeaderFieldConfigsByRowType().

Parameters:

spec - the import specification

Returns:

a map of property names to header names from ImportSpecification.getFieldConfigMap()

buildCsvWriter

protected CSVErrorsReportService.AutoCloseableCsvWriter buildCsvWriter(File file)

buildCsvWriterSettings

protected com.univocity.parsers.csv.CsvWriterSettings buildCsvWriterSettings()

setLineNumberHeader

public void setLineNumberHeader(String lineNumberHeader)

Header in the error download that maps back to the line number in the original file

setErrorMessageHeader

public void setErrorMessageHeader(String errorMessageHeader)

Header in the error download that maps to the error that occurred with the record

setImportSpecificationService

@Autowired
public void setImportSpecificationService(ImportSpecificationService importSpecificationService)

getImportSpecificationService

protected ImportSpecificationService getImportSpecificationService()