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

java.lang.Object
  extended by com.atlassian.confluence.search.didyoumean.lucene.IncrementalIndexBuilder
All Implemented Interfaces:
IndexBuilder

public class IncrementalIndexBuilder
extends java.lang.Object
implements IndexBuilder

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.


Constructor Summary
IncrementalIndexBuilder(com.atlassian.bonnie.ILuceneConnection didYouMeanLuceneConnection, com.atlassian.bonnie.ILuceneConnection luceneConnection)
           
 
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

IncrementalIndexBuilder

public IncrementalIndexBuilder(com.atlassian.bonnie.ILuceneConnection didYouMeanLuceneConnection,
                               com.atlassian.bonnie.ILuceneConnection luceneConnection)
                        throws java.io.IOException
Throws:
java.io.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 AND there is an existing did-you-mean index to perform an incremental index on, 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.


Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.