org.nuxeo.ecm.core.storage

Class FulltextUpdaterWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.core.storage.FulltextUpdaterWork

All Implemented Interfaces:

Serializable, Work

public class FulltextUpdaterWork
extends AbstractWork

Work task that inserts the fulltext (extracted manually by the session at save time, or through FulltextExtractorWork) into the fulltext table.

This is done single-threaded through the use of a WorkManager queue with only one thread.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FulltextUpdaterWork.IndexAndText

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	FULLTEXT_DEFAULT_INDEX
static String	SYSPROP_FULLTEXT_BINARY
static String	SYSPROP_FULLTEXT_JOBID
static String	SYSPROP_FULLTEXT_SIMPLE

Constructor Summary

Constructors

Constructor and Description
FulltextUpdaterWork(String repositoryName, String docId, boolean isSimpleText, boolean isJob, List<FulltextUpdaterWork.IndexAndText> indexesAndText)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCategory() Gets the category for this work.
int	getRetryCount() Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.
String	getTitle() Gets a human-readable name for this work instance.
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, 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

SYSPROP_FULLTEXT_SIMPLE

public static final String SYSPROP_FULLTEXT_SIMPLE

See Also:

Constant Field Values

SYSPROP_FULLTEXT_BINARY

public static final String SYSPROP_FULLTEXT_BINARY

See Also:

Constant Field Values

SYSPROP_FULLTEXT_JOBID

public static final String SYSPROP_FULLTEXT_JOBID

See Also:

Constant Field Values

FULLTEXT_DEFAULT_INDEX

public static final String FULLTEXT_DEFAULT_INDEX

See Also:

Constant Field Values

Constructor Detail

FulltextUpdaterWork

public FulltextUpdaterWork(String repositoryName,
                   String docId,
                   boolean isSimpleText,
                   boolean isJob,
                   List<FulltextUpdaterWork.IndexAndText> indexesAndText)

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

getRetryCount

public int getRetryCount()

Description copied from class: AbstractWork

Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.

Overrides:

getRetryCount in class AbstractWork

Returns:

0 for no retry, or more if some retries are possible

See Also:

AbstractWork.work()

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)