com.atlassian.confluence.search.didyoumean.lucene
Class FullIndexBuilder

java.lang.Object
  com.atlassian.confluence.search.didyoumean.lucene.FullIndexBuilder

All Implemented Interfaces:

IndexBuilder

public class FullIndexBuilder
extends Object
implements IndexBuilder

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

Constructor Summary

FullIndexBuilder(ILuceneConnection didYouMeanLuceneConnection, ILuceneConnection luceneConnection, org.apache.lucene.analysis.Analyzer didYouMeanAnalyzer, File didYouMeanIndexDirectory)

Method Summary

void	build() Triggers the build of the index.
void	build(EstimatedProgressMeter progressMeter) Triggers the build of the index.
boolean	isReady()

Methods inherited from class java.lang.Object

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

Constructor Detail

FullIndexBuilder

public FullIndexBuilder(ILuceneConnection didYouMeanLuceneConnection,
                        ILuceneConnection luceneConnection,
                        org.apache.lucene.analysis.Analyzer didYouMeanAnalyzer,
                        File didYouMeanIndexDirectory)
                 throws IOException

Throws:

IOException

Method Detail

isReady

public boolean isReady()

Specified by:

isReady in interface IndexBuilder

Returns:

true if the WordExtractor.DID_YOU_MEAN_FIELD is found in the Confluence index and contains values, false otherwise.

build

public void build()

Description copied from interface: IndexBuilder

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

Specified by:

build in interface IndexBuilder

build

public void build(EstimatedProgressMeter progressMeter)

Description copied from interface: IndexBuilder

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

Specified by:

build in interface IndexBuilder

Parameters:

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