Package com.atlassian.confluence.internal.search.tasks

Class AddChangeDocumentIndexTask

java.lang.Object

com.atlassian.confluence.internal.search.tasks.AddChangeDocumentIndexTask

All Implemented Interfaces:

ConfluenceIndexTask, ConvertibleToJournalEntry, HandleAware, IndexTask

@LuceneIndependent
@Internal
public class AddChangeDocumentIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Responsible for removing and adding a change document for versioned content to the change index. Enforces a maximum of one change document per user per piece of current content.

Constructor Summary

Constructors

Constructor	Description
AddChangeDocumentIndexTask(Searchable searchable, AtlassianDocumentBuilder<Searchable> changeDocumentBuilder)

Method Summary

Modifier and Type	Method	Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId)	Convert to journal entry.
boolean	equals(Object obj)
String	getDescription()	A description of the task that can be presented to the user via the UI.
Handle	getHandle()
SearchIndex	getSearchIndex()
int	hashCode()
void	perform(SearchIndexWriter writer)	Executes this task against a document writer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AddChangeDocumentIndexTask

public AddChangeDocumentIndexTask(Searchable searchable,
                                  AtlassianDocumentBuilder<Searchable> changeDocumentBuilder)

Parameters:

searchable - a Versioned searchable

changeDocumentBuilder - instance of LuceneDocumentBuilder

Throws:

IllegalArgumentException - if searchable is invalid.

Method Detail

getHandle

public Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle

getDescription

public String getDescription()

Description copied from interface: IndexTask

A description of the task that can be presented to the user via the UI.

Specified by:

getDescription in interface IndexTask

Returns:

an readable message.

perform

public void perform(SearchIndexWriter writer)
             throws IOException

Description copied from interface: ConfluenceIndexTask

Executes this task against a document writer.

Specified by:

perform in interface ConfluenceIndexTask

Throws:

IOException

convertToJournalEntry

public Optional<JournalEntry> convertToJournalEntry(JournalIdentifier journalId)

Description copied from interface: ConvertibleToJournalEntry

Convert to journal entry.

Specified by:

convertToJournalEntry in interface ConvertibleToJournalEntry

Parameters:

journalId - journal identifier

Returns:

an optional containing a journal entry or empty if this cannot be converted.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to