org.nuxeo.ecm.csv

Class CSVImporterWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.csv.CSVImporterWork

All Implemented Interfaces:

Serializable, Work

public class CSVImporterWork
extends AbstractWork

Work task to import form a CSV file. Because the file is read from the local filesystem, this must be executed in a local queue. Since NXP-15252 the CSV reader manages "records", not "lines".

Since:

5.7

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work

Work.Progress, Work.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_CSV_IMPORTER
static String	CONTENT_FILED_TYPE_NAME
static String	LABEL_CSV_IMPORTER_CANNOT_CONVERT_FIELD_VALUE
static String	LABEL_CSV_IMPORTER_DOCUMENT_ALREADY_EXISTS
static String	LABEL_CSV_IMPORTER_DOCUMENT_CREATED
static String	LABEL_CSV_IMPORTER_DOCUMENT_UPDATED
static String	LABEL_CSV_IMPORTER_EMPTY_FILE
static String	LABEL_CSV_IMPORTER_EMPTY_LINE
static String	LABEL_CSV_IMPORTER_ERROR_DURING_IMPORT
static String	LABEL_CSV_IMPORTER_ERROR_IMPORTING_LINE
static String	LABEL_CSV_IMPORTER_MISSING_NAME_OR_TYPE_COLUMN
static String	LABEL_CSV_IMPORTER_MISSING_NAME_VALUE
static String	LABEL_CSV_IMPORTER_MISSING_TYPE_VALUE
static String	LABEL_CSV_IMPORTER_NOT_ALLOWED_SUB_TYPE
static String	LABEL_CSV_IMPORTER_NOT_EXISTING_FIELD
static String	LABEL_CSV_IMPORTER_NOT_EXISTING_FILE
static String	LABEL_CSV_IMPORTER_NOT_EXISTING_TYPE
static String	LABEL_CSV_IMPORTER_PARENT_DOES_NOT_EXIST
static String	LABEL_CSV_IMPORTER_UNABLE_TO_CREATE
static String	LABEL_CSV_IMPORTER_UNABLE_TO_SAVE
static String	LABEL_CSV_IMPORTER_UNABLE_TO_UPDATE
static String	NUXEO_CSV_BLOBS_FOLDER
static String	NUXEO_CSV_MAIL_TO

Constructor Summary

Constructors

Constructor and Description
CSVImporterWork(String id)
CSVImporterWork(String repositoryName, String parentPath, String username, File csvFile, String csvFileName, CSVImporterOptions options)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCategory() Gets the category for this work.
List<CSVImportLog>	getImportLogs()
String	getTitle() Gets a human-readable name for this work instance.
static Throwable	unwrapException(Throwable t)
void	work() This method should implement the actual work done by the Work instance.

Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork

cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getUserId, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, run, setDocument, setDocument, setDocuments, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NUXEO_CSV_MAIL_TO

public static final String NUXEO_CSV_MAIL_TO

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_NOT_EXISTING_FIELD

public static final String LABEL_CSV_IMPORTER_NOT_EXISTING_FIELD

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_CANNOT_CONVERT_FIELD_VALUE

public static final String LABEL_CSV_IMPORTER_CANNOT_CONVERT_FIELD_VALUE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_NOT_EXISTING_FILE

public static final String LABEL_CSV_IMPORTER_NOT_EXISTING_FILE

See Also:

Constant Field Values

NUXEO_CSV_BLOBS_FOLDER

public static final String NUXEO_CSV_BLOBS_FOLDER

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_DOCUMENT_ALREADY_EXISTS

public static final String LABEL_CSV_IMPORTER_DOCUMENT_ALREADY_EXISTS

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_UNABLE_TO_UPDATE

public static final String LABEL_CSV_IMPORTER_UNABLE_TO_UPDATE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_DOCUMENT_UPDATED

public static final String LABEL_CSV_IMPORTER_DOCUMENT_UPDATED

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_UNABLE_TO_CREATE

public static final String LABEL_CSV_IMPORTER_UNABLE_TO_CREATE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_PARENT_DOES_NOT_EXIST

public static final String LABEL_CSV_IMPORTER_PARENT_DOES_NOT_EXIST

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_DOCUMENT_CREATED

public static final String LABEL_CSV_IMPORTER_DOCUMENT_CREATED

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_NOT_ALLOWED_SUB_TYPE

public static final String LABEL_CSV_IMPORTER_NOT_ALLOWED_SUB_TYPE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_UNABLE_TO_SAVE

public static final String LABEL_CSV_IMPORTER_UNABLE_TO_SAVE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_ERROR_IMPORTING_LINE

public static final String LABEL_CSV_IMPORTER_ERROR_IMPORTING_LINE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_NOT_EXISTING_TYPE

public static final String LABEL_CSV_IMPORTER_NOT_EXISTING_TYPE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_MISSING_TYPE_VALUE

public static final String LABEL_CSV_IMPORTER_MISSING_TYPE_VALUE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_MISSING_NAME_VALUE

public static final String LABEL_CSV_IMPORTER_MISSING_NAME_VALUE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_MISSING_NAME_OR_TYPE_COLUMN

public static final String LABEL_CSV_IMPORTER_MISSING_NAME_OR_TYPE_COLUMN

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_EMPTY_FILE

public static final String LABEL_CSV_IMPORTER_EMPTY_FILE

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_ERROR_DURING_IMPORT

public static final String LABEL_CSV_IMPORTER_ERROR_DURING_IMPORT

See Also:

Constant Field Values

LABEL_CSV_IMPORTER_EMPTY_LINE

public static final String LABEL_CSV_IMPORTER_EMPTY_LINE

See Also:

Constant Field Values

CATEGORY_CSV_IMPORTER

public static final String CATEGORY_CSV_IMPORTER

See Also:

Constant Field Values

CONTENT_FILED_TYPE_NAME

public static final String CONTENT_FILED_TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

CSVImporterWork

public CSVImporterWork(String id)

CSVImporterWork

public CSVImporterWork(String repositoryName,
               String parentPath,
               String username,
               File csvFile,
               String csvFileName,
               CSVImporterOptions options)

Method Detail

getCategory

public String getCategory()

Description copied from interface: Work

Gets the category for this work.

Used to choose an execution queue.

Specified by:

getCategory in interface Work

Overrides:

getCategory in class AbstractWork

Returns:

the category, or null for the default

getTitle

public String getTitle()

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name

getImportLogs

public List<CSVImportLog> getImportLogs()

work

public void work()

Description copied from interface: Work

This method should implement the actual work done by the Work instance.

It should periodically update its progress through Work.setProgress(org.nuxeo.ecm.core.work.api.Work.Progress).

To allow for suspension by the WorkManager, it should periodically call Work.isSuspending(), and if true call Work.suspended() return early with saved state data.

Clean up can by implemented by #cleanUp().

Specified by:

work in interface Work

Specified by:

work in class AbstractWork

See Also:

Work.isSuspending(), Work.suspended(), Work.cleanUp(boolean, java.lang.Exception)

unwrapException

public static Throwable unwrapException(Throwable t)