com.broadleafcommerce.dataimport.service

Interface FileImportProcessor

All Known Implementing Classes:

AssetImportProcessor, CSVFileImportProcessor

public interface FileImportProcessor

The main interface responsible for actually parsing a file. This is usually invoked from the ImportService in order to process the file.

Author:

Elbert Bautista (elbertbautista), Phillip Verheyden (phillipuniverse)

See Also:

CSVFileImportProcessor}

Method Summary

Modifier and Type	Method and Description
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
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.

Method Detail

processFile

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

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

Parameters:

uploadedFile - the original file that was uploaded by the user

process - the process that was created

Throws:

ImportException - if there was a problem in processing the inputStream

canHandle

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

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

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

int calculateTotalRecords(File uploadedFile)
                   throws ImportException

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

Returns:

the number of records that will be processed

Throws:

ImportException - if there was a problem in processing the uploadedFile