com.atlassian.confluence.search.lucene.tasks

Class AddDocumentIndexTask

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.AddDocumentIndexTask

All Implemented Interfaces:

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

public class AddDocumentIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Adds a searchable to the content index.

Constructor Summary

Constructors

Constructor and Description
AddDocumentIndexTask(com.atlassian.bonnie.Searchable searchable, com.atlassian.bonnie.search.DocumentBuilder documentBuilder)

Method Summary

Modifier and Type	Method and Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId) Convert to journal entry.
boolean	equals(Object o)
String	getDescription() A human readable description of this index task.
com.atlassian.bonnie.Handle	getHandle()
SearchIndex	getSearchIndex()
int	hashCode()
void	perform(org.apache.lucene.index.IndexWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

AddDocumentIndexTask

public AddDocumentIndexTask(com.atlassian.bonnie.Searchable searchable,
                            com.atlassian.bonnie.search.DocumentBuilder documentBuilder)

Method Detail

perform

public void perform(org.apache.lucene.index.IndexWriter writer)
             throws IOException

Specified by:

perform in interface com.atlassian.bonnie.ILuceneConnection.WriterAction

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.

getDescription

public String getDescription()

A human readable description of this index task.

Specified by:

getDescription in interface IndexTask

Returns:

an readable message.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHandle

public com.atlassian.bonnie.Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to