com.atlassian.bamboo.index

Interface Indexer

All Known Subinterfaces:

BuildResultsIndexer, EnvironmentIndexer, QuickSearchIndexer, VersionIndexer

All Known Implementing Classes:

AbstractIndexer, DefaultBuildResultsIndexer, EnvironmentIndexerImpl, QuickSearchIndexerImpl, VersionIndexerImpl

@Internal
public interface Indexer

Standard interface for anything that wants to index stuff in Bamboo. Each indexer will have its own index.

Since:

v5.3

Method Summary

Modifier and Type	Method and Description
void	deleteIndex() Delete existing index.
long	getEstimatedReindexTime() How long will it take to reindex all objects in this index.
int	getNumberOfDocuments()
void	indexAll(Executor executor) Reindexes anything this index is supposed to have in it.

Method Detail

indexAll

void indexAll(@NotNull
              Executor executor)
       throws Exception

Reindexes anything this index is supposed to have in it. Indexers are supposed to use executor to split the job into reasonable-sized chunks.

Parameters:

executor - allows multithreaded execution of indexer

Throws:

Exception

deleteIndex

void deleteIndex()

Delete existing index.

getEstimatedReindexTime

long getEstimatedReindexTime()

How long will it take to reindex all objects in this index.

Returns:

seconds of how long

getNumberOfDocuments

int getNumberOfDocuments()

Returns:

number of documents in the index