com.atlassian.confluence.plugins.edgeindex.tasks

Class AddEdgeDocumentIndexTask

java.lang.Object

com.atlassian.confluence.plugins.edgeindex.tasks.AddEdgeDocumentIndexTask

All Implemented Interfaces:

com.atlassian.bonnie.ILuceneConnection.WriterAction, EdgeIndexTask, ConvertibleToJournalEntry, IndexTask, ConfluenceIndexTask

public class AddEdgeDocumentIndexTask
extends Object
implements EdgeIndexTask

Since:

7.17

Constructor Summary

Constructors

Constructor and Description
AddEdgeDocumentIndexTask(AtlassianDocument document)

Method Summary

Modifier and Type	Method and Description
String	getDescription() A description of the task that can be presented to the user via the UI.
SearchIndex	getSearchIndex()
void	perform(SearchIndexWriter writer) Executes this task against a document writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.plugins.edgeindex.EdgeIndexTask

convertToJournalEntry

Methods inherited from interface com.atlassian.confluence.search.lucene.tasks.ConfluenceIndexTask

getSearchIndexAccessor, perform

Constructor Detail

AddEdgeDocumentIndexTask

public AddEdgeDocumentIndexTask(AtlassianDocument document)

Method Detail

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to

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

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.