de.hybris.platform.importcockpit.services.media

Interface ImportCockpitMediaService

All Known Implementing Classes:

DefaultImportCockpitMediaService

public interface ImportCockpitMediaService

Provides service methods for Import Cockpit medias.

Method Summary

Modifier and Type	Method and Description
ImpExMediaModel	createMediaFromFile(String filePackageName) Give the supplied filename (full file path), this method will create and return an ImpExMediaModel.
CSVReader	createMediaReader(ImportCockpitInputMediaModel media) Creates a media reader for the source file.
List<SourceColumnModel>	getSourceColumnData(ImportCockpitCronJobModel icCronJobModel) Given the supplied ImportCockpitCronJobModel, this method will return all the the data for each field(column) as a List of SourceColumnModel.
List<String>	getSourceColumnNames(ImportCockpitInputMediaModel media) Retrieves the source column names/labels of the uploaded source file.
boolean	validateInputFile(ImportCockpitInputMediaModel inputMedia) Validates the ImportCockpitInputMediaModel (CSV format) that is to be assigned to an ImportCockpitCronJobModel.

Method Detail

createMediaReader

CSVReader createMediaReader(ImportCockpitInputMediaModel media)
                     throws JaloBusinessException,
                            UnsupportedEncodingException

Creates a media reader for the source file.

Parameters:

media - CSV source file uploaded to the cron job

Returns:

reader for CSV files

Throws:

JaloBusinessException

UnsupportedEncodingException

validateInputFile

boolean validateInputFile(ImportCockpitInputMediaModel inputMedia)

Validates the ImportCockpitInputMediaModel (CSV format) that is to be assigned to an ImportCockpitCronJobModel.

Parameters:

inputMedia - - ImportCockpitInputMediaModel

Returns:

true if the ImportCockpitInputMediaModel is valid false otherwise.

getSourceColumnNames

List<String> getSourceColumnNames(ImportCockpitInputMediaModel media)

Retrieves the source column names/labels of the uploaded source file.

Parameters:

media - of type ImportCockpitInputMediaModel.

Returns:

list of column names/labels (String).

getSourceColumnData

List<SourceColumnModel> getSourceColumnData(ImportCockpitCronJobModel icCronJobModel)

Given the supplied ImportCockpitCronJobModel, this method will return all the the data for each field(column) as a List of SourceColumnModel.

Parameters:

icCronJobModel - the cron job of type ImportCockpitCronJobModel to retrieve the the source column data from.

Returns:

srcColumnModelList - List of SourceColumnModels that represents the data stored in the source used for mapping.

createMediaFromFile

ImpExMediaModel createMediaFromFile(String filePackageName)
                             throws FileNotFoundException

Give the supplied filename (full file path), this method will create and return an ImpExMediaModel.

Parameters:

filePackageName - - A String representing the location of the file that will be used to create an ImpExMediaModel.

Returns:

impExMediaModel an ImpExMediaModel

Throws:

FileNotFoundException - - Occurs when the file (as per filename) is not found.