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
protected static String	CATEGORY
static String	FULLTEXT_DEFAULT_INDEX
protected List<FulltextUpdaterWork.IndexAndText>	indexesAndText The indexes and text to be updated.
protected boolean	isJob If true, then all the documents with the id as their jobId are updated.
protected boolean	isSimpleText Is this a simple text index or a binary text one.
static String	SYSPROP_FULLTEXT_BINARY
static String	SYSPROP_FULLTEXT_JOBID
static String	SYSPROP_FULLTEXT_SIMPLE
protected static String	TITLE

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

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

Method Summary

Modifier and Type	Method and Description
String	getCategory() Gets the category for this work.
protected String	getFulltextPropertyName(String indexName)
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.
protected void	update()
protected void	updateWithSession(CoreSession session)
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, getPartitionKey, getProgress, getSchedulePath, getSchedulingTime, getStartTime, getStatus, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, 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

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

CATEGORY

protected static final String CATEGORY

See Also:

Constant Field Values

TITLE

protected static final String TITLE

See Also:

Constant Field Values

isSimpleText

protected final boolean isSimpleText

Is this a simple text index or a binary text one.

isJob

protected final boolean isJob

If true, then all the documents with the id as their jobId are updated.

indexesAndText

protected final List<FulltextUpdaterWork.IndexAndText> indexesAndText

The indexes and text to be updated.

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)

updateWithSession

protected void updateWithSession(CoreSession session)

update

protected void update()

getFulltextPropertyName

protected String getFulltextPropertyName(String indexName)