public class

FullIndexBuilder

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

Class Overview

Builder that extracts unique words from the DID_YOU_MEAN_FIELD in Confluence's index and adds them to a did-you-mean index (a separate secondary index).

Summary

Public Constructors
FullIndexBuilder(ILuceneConnection didYouMeanLuceneConnection, ILuceneConnection luceneConnection, Analyzer didYouMeanAnalyzer, File didYouMeanIndexDirectory)
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 FullIndexBuilder (ILuceneConnection didYouMeanLuceneConnection, ILuceneConnection luceneConnection, Analyzer didYouMeanAnalyzer, File didYouMeanIndexDirectory)

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, false otherwise.