com.atlassian.confluence.search.lucene.tasks
Class UpdateDocumentIndexTask

java.lang.Object
  com.atlassian.confluence.search.lucene.tasks.BaseContentIndexTask
      com.atlassian.confluence.search.lucene.tasks.UpdateDocumentIndexTask

All Implemented Interfaces:

ContentIndexTask, IndexTask

public class UpdateDocumentIndexTask
extends BaseContentIndexTask

Field Summary

Fields inherited from class com.atlassian.confluence.search.lucene.tasks.BaseContentIndexTask

anyTypeObjectDao, documentBuilder, handle, spaceKey, target

Constructor Summary

UpdateDocumentIndexTask(com.atlassian.bonnie.Searchable searchable)

UpdateDocumentIndexTask(java.lang.String handle)

Method Summary

AddDocumentIndexTask	getAddTask(IndexTaskFactory factory) Returns the second part of the update: adding the updated document to the index
DeleteDocumentIndexTask	getDeleteTask(IndexTaskFactory factory) Returns the first part of the update: the removal of the old document from the index
java.lang.String	getDescription() A description of the task that can be presented to the user via the UI.

Methods inherited from class com.atlassian.confluence.search.lucene.tasks.BaseContentIndexTask

createHandle, createHandle, equals, getHandle, getTarget, hashCode, setAnyTypeObjectDao, setDocumentBuilder, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateDocumentIndexTask

public UpdateDocumentIndexTask(com.atlassian.bonnie.Searchable searchable)

UpdateDocumentIndexTask

public UpdateDocumentIndexTask(java.lang.String handle)
                        throws java.text.ParseException

Throws:

java.text.ParseException

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: IndexTask

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

Returns:

an readable message.

getDeleteTask

public DeleteDocumentIndexTask getDeleteTask(IndexTaskFactory factory)
                                      throws java.text.ParseException

Returns the first part of the update: the removal of the old document from the index

Throws:

java.text.ParseException

getAddTask

public AddDocumentIndexTask getAddTask(IndexTaskFactory factory)
                                throws java.text.ParseException

Returns the second part of the update: adding the updated document to the index

Throws:

java.text.ParseException