Package org.ametys.plugins.contentio.csv

Class ImportCSVFileHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.csv.ImportCSVFileHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class ImportCSVFileHelper
extends AbstractLogEnabled
implements Component, Serviceable, Initializable

Import contents from an uploaded CSV file.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
ImportCSVFileHelper()

Method Summary

Modifier and Type	Method	Description
void	deleteFile(String path)	Delete the file related to the given path
Map<String,Object>	getImportCSVParametersValues(String contentTypeId)	Retrieves the values for import CSV parameters
Map<String,Object>	importContents(Map<String,Object> config, Map<String,Object> formValues, List<Map<String,Object>> mappingValues)	Gets the configuration for creating/editing a collection of synchronizable contents.
void	initialize()
void	service(ServiceManager serviceManager)
Map<String,Object>	validateConfiguration(String contentTypeId, Map formValues, List<Map<String,Object>> mappingValues)	Gets the configuration for creating/editing a collection of synchronizable contents.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

Avalon Role

Constructor Detail

ImportCSVFileHelper

public ImportCSVFileHelper()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getImportCSVParametersValues

public Map<String,Object> getImportCSVParametersValues(String contentTypeId)

Retrieves the values for import CSV parameters

Parameters:

contentTypeId - the configured content type identifier

Returns:

the values for import CSV parameters

validateConfiguration

public Map<String,Object> validateConfiguration(String contentTypeId,
                                                      Map formValues,
                                                      List<Map<String,Object>> mappingValues)
                                               throws IOException

Gets the configuration for creating/editing a collection of synchronizable contents.

Parameters:

contentTypeId - Content type id

formValues - map of form values

mappingValues - list of header and content attribute mapping

Returns:

A map containing information about what is needed to create/edit a collection of synchronizable contents

Throws:

IOException - IOException while reading CSV

importContents

public Map<String,Object> importContents(Map<String,Object> config,
                                               Map<String,Object> formValues,
                                               List<Map<String,Object>> mappingValues)
                                        throws IOException

Gets the configuration for creating/editing a collection of synchronizable contents.

Parameters:

config - get all CSV related parameters: path, separating/escaping char, charset and contentType

formValues - map of form values

mappingValues - list of header and content attribute mapping

Returns:

A map containing information about what is needed to create/edit a collection of synchronizable contents

Throws:

IOException - IOException while reading CSV

deleteFile

public void deleteFile(String path)
                throws IOException

Delete the file related to the given path

Parameters:

path - path of the file

Throws:

IOException - if an error occurs while deleting the file