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

Class AddDocumentIndexTask

java.lang.Object

com.atlassian.confluence.internal.search.tasks.AddDocumentIndexTask

All Implemented Interfaces:

ConfluenceIndexTask, ConvertibleToJournalEntry, HandleAware, IndexTask

Direct Known Subclasses:

AddPrefetchedDocumentIndexTask

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

Adds a searchable to the content index.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtlassianDocumentBuilder<Searchable>	documentBuilder
protected final HibernateHandle	handle
protected final Searchable	searchable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AddDocumentIndexTask(Searchable searchable)
	AddDocumentIndexTask(Searchable searchable, AtlassianDocumentBuilder<Searchable> documentBuilder)

Method Summary

Modifier and Type	Method	Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId)	Convert to journal entry.
boolean	equals(Object o)
String	getDescription()	A human readable description of this index task.
Handle	getHandle()
SearchIndex	getSearchIndex()
int	hashCode()
boolean	isRetryable()
void	perform(SearchIndexWriter writer)	Executes this task against a document writer.

Methods inherited from class java.lang.Object

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

Field Details

documentBuilder

protected final AtlassianDocumentBuilder<Searchable> documentBuilder

searchable

protected final Searchable searchable

handle

protected final HibernateHandle handle

Constructor Details

AddDocumentIndexTask

protected AddDocumentIndexTask(Searchable searchable)

AddDocumentIndexTask

public AddDocumentIndexTask(Searchable searchable,
 AtlassianDocumentBuilder<Searchable> documentBuilder)

Method Details

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

isRetryable

public boolean isRetryable()

Specified by:

isRetryable in interface ConfluenceIndexTask

Returns:

true if this task is retryable in journal queue, false otherwise.

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 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