org.nuxeo.apidoc.worker

Class ExtractXmlAttributesWorker

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.apidoc.worker.ExtractXmlAttributesWorker

All Implemented Interfaces:

Serializable, Work

public class ExtractXmlAttributesWorker
extends AbstractWork

Since:

8.3

Author:

Arnaud Kervern

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ExtractXmlAttributesWorker.Handler

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

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

callerThread, completionTime, docId, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExtractXmlAttributesWorker(String repositoryName, String docId)
	ExtractXmlAttributesWorker(String repositoryName, String originatingUsername, String docId)

Method Summary

Modifier and Type	Method and Description
String	extractAttributes(Blob blob)
String	getCategory() Gets the category for this work.
String	getTitle() Gets a human-readable name for this work instance.
protected DocumentModel	loadDocument()
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, getOriginatingUsername, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CATEGORY

public static final String CATEGORY

See Also:

Constant Field Values

Constructor Detail

ExtractXmlAttributesWorker

protected ExtractXmlAttributesWorker(String repositoryName,
                                     String docId)

ExtractXmlAttributesWorker

public ExtractXmlAttributesWorker(String repositoryName,
                                  String originatingUsername,
                                  String docId)

Method Detail

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)

loadDocument

protected DocumentModel loadDocument()
                              throws DocumentNotFoundException

Throws:

DocumentNotFoundException

extractAttributes

public String extractAttributes(Blob blob)
                         throws ParserConfigurationException,
                                SAXException,
                                IOException

Throws:

ParserConfigurationException

SAXException

IOException

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