Package org.ametys.plugins.contentio.csv

Class CSVImporter

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.csv.CSVImporter

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

SkillCSVImporter

public class CSVImporter
extends AbstractLogEnabled
implements Component, Serviceable

Import contents from an uploaded CSV file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	CSVImporter.SynchronizeResult	Synchronize result

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESULT_CONTENT_IDS	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
CSVImporter()

Method Summary

Modifier and Type	Method	Description
protected List<Expression>	additionalExpressionToRetrieveContent(Map<String,Object> mapping, Map<String,String> row, ContentType contentType, Optional<? extends Content> parentContent, Map<String,Object> additionalTransientVars, List<String> valuesUsedAsIds)	Returns a list of additional expression to retrieve the existing content
Map<String,Object>	importContentsFromCSV(Map<String,Object> mapping, View view, ContentType contentType, ICsvListReader listReader, int createAction, int editAction, String workflowName, String language, SynchronizeModeEnumerator.ImportMode importMode, Optional<? extends Content> parentContent, Map<String,Object> additionalTransientVars)	Extract contents from CSV file
protected CSVImporter.SynchronizeResult	processContent(View view, Map<String,String> row, ContentType contentType, Map<String,Object> mapping, int createAction, int editAction, String workflowName, String language, List<ViewItem> errors, SynchronizeModeEnumerator.ImportMode importMode, Optional<? extends Content> parentContent, Map<String,Object> additionalTransientVars)	Process content for CSV import or synchronization
void	service(ServiceManager smanager)

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_CONTENT_IDS

public static final String RESULT_CONTENT_IDS

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

Constructor Details

CSVImporter

public CSVImporter()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

importContentsFromCSV

public Map<String,Object> importContentsFromCSV(Map<String,Object> mapping,
 View view,
 ContentType contentType,
 ICsvListReader listReader,
 int createAction,
 int editAction,
 String workflowName,
 String language,
 SynchronizeModeEnumerator.ImportMode importMode,
 Optional<? extends Content> parentContent,
 Map<String,Object> additionalTransientVars)
                                         throws IOException

Extract contents from CSV file

Parameters:

mapping - mapping of content attributes and CSV file header

view - View of importing content

contentType - content type to import

listReader - mapReader to parse CSV file

createAction - creation action id

editAction - edition action id

workflowName - workflow name

language - language of created content.

importMode - The import mode

parentContent - Optional parent content

additionalTransientVars - The optional additional transient vars to add to the transient vars

Returns:

list of created contents

Throws:

IOException - IOException while reading CSV

processContent

protected CSVImporter.SynchronizeResult processContent(View view,
 Map<String,String> row,
 ContentType contentType,
 Map<String,Object> mapping,
 int createAction,
 int editAction,
 String workflowName,
 String language,
 List<ViewItem> errors,
 SynchronizeModeEnumerator.ImportMode importMode,
 Optional<? extends Content> parentContent,
 Map<String,Object> additionalTransientVars)
                                                throws Exception

Process content for CSV import or synchronization

Parameters:

view - The view

row - The row containing the values

contentType - The content type

mapping - The mapping

createAction - The create action

editAction - The edit action

workflowName - The wokflow name

language - The language

errors - The errors

importMode - The import mode

parentContent - The parent content

additionalTransientVars - The additional transient vars

Returns:

The synchronize result

Throws:

Exception - If an error occurs

additionalExpressionToRetrieveContent

protected List<Expression> additionalExpressionToRetrieveContent(Map<String,Object> mapping,
 Map<String,String> row,
 ContentType contentType,
 Optional<? extends Content> parentContent,
 Map<String,Object> additionalTransientVars,
 List<String> valuesUsedAsIds)

Returns a list of additional expression to retrieve the existing content

Parameters:

mapping - The mapping

row - The row

contentType - The content type

parentContent - The parent content

additionalTransientVars - Additional transients vars

valuesUsedAsIds - The values used as ids, if some values are added in expression, they can be added in this list to be printed in error logs

Returns:

a list of additional expression to retrieve the existing content