com.atlassian.confluence.search.didyoumean
Interface IndexBuilder

All Known Implementing Classes:

FullIndexBuilder, IncrementalIndexBuilder

public interface IndexBuilder

Builds an index to produce "did you mean" suggestions.

Method Summary

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

Method Detail

isReady

boolean isReady()

Returns:

true if all preconditions have been met to allow the index build to proceed successfully, false otherwise. You must call this first before calling build().

build

void build()

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

Throws:

IndexIOException - if there is an error in the underlying index during the build

IllegalStateException - if this is called when isReady() returns false.

build

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.

Throws:

IndexIOException - if there is an error in the underlying index during the build

IllegalStateException - if this is called when isReady() returns false.

IllegalArgumentException - if progress meter specified is null