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:

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

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, retryableWork, rollbackAndRetryTransaction, setDocument, setDocument, setDocuments, setProgress, setSchedulePath, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

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

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

Overrides:

work in class AbstractWork

Throws:

Exception

See Also:

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

unwrapException

public static Throwable unwrapException(Throwable t)