public class

IncrementalIndexBuilder

extends Object
implements IndexBuilder
java.lang.Object
   ↳ com.atlassian.confluence.search.didyoumean.lucene.IncrementalIndexBuilder

Class Overview

Performs an incremental update of the did-you-mean index by adding any new words and removing ones that are no longer used anymore in Confluence content.

Summary

Public Constructors
IncrementalIndexBuilder(ILuceneConnection didYouMeanLuceneConnection, ILuceneConnection luceneConnection)
Public Methods
void build(EstimatedProgressMeter progressMeter)
Triggers the build of the index.
void build()
Triggers the build of the index.
boolean isReady()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.search.didyoumean.IndexBuilder

Public Constructors

public IncrementalIndexBuilder (ILuceneConnection didYouMeanLuceneConnection, ILuceneConnection luceneConnection)

Throws
IOException

Public Methods

public void build (EstimatedProgressMeter progressMeter)

Triggers the build of the index. You must check isReady() first before invoking this method.

Parameters
progressMeter progress made by this builder will be reflected on this progressMeter. Cannot be null.

public void build ()

Triggers the build of the index. You must check isReady() first before invoking this method.

public boolean isReady ()

Returns
  • true if the DID_YOU_MEAN_FIELD is found in the Confluence index and contains values AND there is an existing did-you-mean index to perform an incremental index on, false otherwise.