Package com.atlassian.confluence.search

Class ReIndexTask

java.lang.Object

com.atlassian.confluence.search.ReIndexTask

All Implemented Interfaces:

ReIndexTaskInfo, Runnable

public class ReIndexTask
extends Object
implements Runnable, ReIndexTaskInfo

Constructor Summary

Constructors

Constructor	Description
ReIndexTask(Reindexer reIndexer, SearchableDao searchableDao, EnumSet<ReIndexOption> options, int jobID)
ReIndexTask(Reindexer reIndexer, SearchableDao searchableDao, EnumSet<ReIndexOption> options, Optional<SearchQuery> searchQuery, int jobID)
ReIndexTask(Reindexer reIndexer, SearchableDao searchableDao, List<String> spaceKeys, EnumSet<ReIndexOption> options, int jobID)
ReIndexTask(Reindexer reIndexer, SearchableDao searchableDao, List<String> spaceKeys, EnumSet<ReIndexOption> options, Optional<SearchQuery> searchQuery, int jobID)

Method Summary

Modifier and Type	Method	Description
String	getCompactElapsedTime()
int	getJobID()
String	getName()
int	getPercentComplete()
Progress	getProgress()
long	getStartTime()
boolean	isFinishedReindexing()
void	run()

Methods inherited from class java.lang.Object

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

Constructor Details

ReIndexTask

public ReIndexTask(Reindexer reIndexer,
 SearchableDao searchableDao,
 EnumSet<ReIndexOption> options,
 int jobID)

Parameters:

reIndexer - The re-indexer to use.

searchableDao - The data access object for searchable entities.

options - Optional. Allows a subset of all searchable content to be re-indexed.

jobID - the identifier for this task.

ReIndexTask

public ReIndexTask(Reindexer reIndexer,
 SearchableDao searchableDao,
 EnumSet<ReIndexOption> options,
 Optional<SearchQuery> searchQuery,
 int jobID)

Parameters:

reIndexer - The re-indexer to use.

searchableDao - The data access object for searchable entities.

options - Optional. Allows a subset of all searchable content to be re-indexed.

searchQuery - Optional. A query that may be used to load the entities to be re-indexed. Pass null to index all entities from the database.

jobID - the identifier for this task.

Since:

5.10

ReIndexTask

public ReIndexTask(Reindexer reIndexer,
 SearchableDao searchableDao,
 List<String> spaceKeys,
 EnumSet<ReIndexOption> options,
 int jobID)

Since:

8.2.0

ReIndexTask

public ReIndexTask(Reindexer reIndexer,
 SearchableDao searchableDao,
 List<String> spaceKeys,
 EnumSet<ReIndexOption> options,
 Optional<SearchQuery> searchQuery,
 int jobID)

Parameters:

reIndexer - The re-indexer to use.

searchableDao - The data access object for searchable entities.

options - Optional. Allows a subset of all searchable content to be re-indexed.

searchQuery - Optional. A query that may be used to load the entities to be re-indexed. Pass null to index all entities from the database.

jobID - the identifier for this task.

Since:

8.2.0

Method Details

run

public void run()

Specified by:

run in interface Runnable

getName

public String getName()

getCompactElapsedTime

public String getCompactElapsedTime()

Specified by:

getCompactElapsedTime in interface ReIndexTaskInfo

Returns:

a compact string representation of the elapsed time since the task started

getProgress

public Progress getProgress()

isFinishedReindexing

public boolean isFinishedReindexing()

Specified by:

isFinishedReindexing in interface ReIndexTaskInfo

Returns:

true if the reindexing task has finished, false if it is still in progress

getJobID

public int getJobID()

Specified by:

getJobID in interface ReIndexTaskInfo

Returns:

the unique identifier for this reindexing job

getStartTime

public long getStartTime()

getPercentComplete

public int getPercentComplete()

Specified by:

getPercentComplete in interface ReIndexTaskInfo

Returns:

the percentage of completion as an integer from 0 to 100