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 final String	MAPPING_COLUMN_ATTRIBUTE_PATH	Column name of attribute path in CSV mapping
static final String	MAPPING_COLUMN_HEADER	Column name of header in CSV mapping
static final String	MAPPING_COLUMN_IS_ID	Column name to identify if column is an ID in CSV mapping
static final String	NESTED_MAPPING_ID	Key in nested mapping to define the ID columns
static final String	NESTED_MAPPING_VALUES	Key in nested mapping to define the values columns
static final String	RESULT_ERROR	Result key containing a short an explanation for a general error
static final String	RESULT_FILENAME	Result key containing the filename
static final String	RESULT_IMPORTED_COUNT	Result key containing updated content's ids
static final String	RESULT_NB_ERRORS	Result key containing number of errors
static final String	RESULT_NB_WARNINGS	Result key containing number of warnings
static final 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
Charset	detectCharset(InputStream inputStream)	Detect the charset of a given resource.
String[]	extractHeaders(InputStream inputStream, CsvPreference csvPreference, Charset charset)	Extract headers from the CSV resource.
Map<String,Object>	getImportCSVParametersValues(String contentTypeId)	Retrieves the values for import CSV parameters
List<Map<String,Object>>	getMapping(ContentType contentType, String[] headers)	Get the mapping from the headers and corresponding to the content type.
Map<String,Object>	importContents(InputStream inputStream, ContentType contentType, String language, SynchronizeModeEnumerator.ImportMode importMode)	Import contents from path, content type and language.
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 Details

ROLE

public static final String ROLE

Avalon Role

RESULT_IMPORTED_COUNT

public static final String RESULT_IMPORTED_COUNT

Result key containing updated content's ids

See Also:

• Constant Field Values

RESULT_NB_ERRORS

public static final String RESULT_NB_ERRORS

Result key containing number of errors

See Also:

• Constant Field Values

RESULT_NB_WARNINGS

public static final String RESULT_NB_WARNINGS

Result key containing number of warnings

See Also:

• Constant Field Values

RESULT_ERROR

public static final String RESULT_ERROR

Result key containing a short an explanation for a general error

See Also:

• Constant Field Values

RESULT_FILENAME

public static final String RESULT_FILENAME

Result key containing the filename

See Also:

• Constant Field Values

MAPPING_COLUMN_ATTRIBUTE_PATH

public static final String MAPPING_COLUMN_ATTRIBUTE_PATH

Column name of attribute path in CSV mapping

See Also:

• Constant Field Values

MAPPING_COLUMN_HEADER

public static final String MAPPING_COLUMN_HEADER

Column name of header in CSV mapping

See Also:

• Constant Field Values

MAPPING_COLUMN_IS_ID

public static final String MAPPING_COLUMN_IS_ID

Column name to identify if column is an ID in CSV mapping

See Also:

• Constant Field Values

NESTED_MAPPING_ID

public static final String NESTED_MAPPING_ID

Key in nested mapping to define the ID columns

See Also:

• Constant Field Values

NESTED_MAPPING_VALUES

public static final String NESTED_MAPPING_VALUES

Key in nested mapping to define the values columns

See Also:

• Constant Field Values

Constructor Details

ImportCSVFileHelper

public ImportCSVFileHelper()

Method Details

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)
                                                throws Exception

Retrieves the values for import CSV parameters

Parameters:

contentTypeId - the configured content type identifier

Returns:

the values for import CSV parameters

Throws:

Exception - if an error occurs.

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

importContents

public Map<String,Object> importContents(InputStream inputStream,
 ContentType contentType,
 String language,
 SynchronizeModeEnumerator.ImportMode importMode)
                                  throws IOException

Import contents from path, content type and language. CSV Excel north Europe preferences are used, charset is detected on the file, workflow is detected on content type, default creation (1) and edition (2) actions are used, values are automatically mapped from the header. Headers should contains a star (*) to detect identifier columns.

Parameters:

inputStream - The (buffered) input stream to the CSV resource

contentType - The content type

language - The language

importMode - The import mode

Returns:

the result of the CSV import

Throws:

IOException - if an error occurs

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

detectCharset

public Charset detectCharset(InputStream inputStream)
                      throws IOException

Detect the charset of a given resource.

Parameters:

inputStream - The input stream to the resource, need to support InputStream.mark(int) and InputStream.reset().

Returns:

the charset

Throws:

IOException - if an error occurs

extractHeaders

public String[] extractHeaders(InputStream inputStream,
 CsvPreference csvPreference,
 Charset charset)
                        throws IOException

Extract headers from the CSV resource.

Parameters:

inputStream - The input stream to the resource

csvPreference - The CSV preference (separators)

charset - The charset of the resource

Returns:

the list of headers in file

Throws:

IOException - if an error occurs

getMapping

public List<Map<String,Object>> getMapping(ContentType contentType,
 String[] headers)

Get the mapping from the headers and corresponding to the content type.

Parameters:

contentType - The content type

headers - The CSV headers

Returns:

the list of columns descriptions. An item of the list is one column, each column is defined by a header "header" (text defined into the CSV header), an attribute path "attributePath" (real path extracted from the header, empty if the model item does not exist) and an identifier flag "isId" (true if the header ends with a star "*").