org.jahia.services.search.spell

Class CompositeSpellChecker

java.lang.Object

org.jahia.services.search.spell.CompositeSpellChecker

All Implemented Interfaces:

org.apache.jackrabbit.core.query.lucene.SpellChecker

Direct Known Subclasses:

CompositeSpellChecker.FiveMinutesRefreshInterval, CompositeSpellChecker.FiveSecondsRefreshInterval, CompositeSpellChecker.OneDayRefreshInterval, CompositeSpellChecker.OneHourRefreshInterval, CompositeSpellChecker.OneMinuteRefreshInterval, CompositeSpellChecker.SixHoursRefreshInterval, CompositeSpellChecker.ThirtyMinutesRefreshInterval, CompositeSpellChecker.TwelveHoursRefreshInterval

public class CompositeSpellChecker
extends Object
implements org.apache.jackrabbit.core.query.lucene.SpellChecker

LuceneSpellChecker implements a spell checker based on the terms present in a lucene index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositeSpellChecker.FiveMinutesRefreshInterval
static class	CompositeSpellChecker.FiveSecondsRefreshInterval
static class	CompositeSpellChecker.OneDayRefreshInterval
static class	CompositeSpellChecker.OneHourRefreshInterval
static class	CompositeSpellChecker.OneMinuteRefreshInterval
static class	CompositeSpellChecker.SixHoursRefreshInterval
static class	CompositeSpellChecker.ThirtyMinutesRefreshInterval
static class	CompositeSpellChecker.TwelveHoursRefreshInterval

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_TERMS_PARAM
static String	SEPARATOR_IN_SUGGESTION
static String	SITES_PARAM

Constructor Summary

Constructors

Modifier	Constructor and Description
	CompositeSpellChecker() Spell checker with a default refresh interval of one hour.
protected	CompositeSpellChecker(long refreshInterval)

Method Summary

Modifier and Type	Method and Description
String	check(org.apache.jackrabbit.spi.commons.query.QueryRootNode aqt)
void	close()
void	init(org.apache.jackrabbit.core.query.QueryHandler handler) Initializes this spell checker.
void	updateIndex() Triggers update of the spell checker dictionary index.
void	updateIndex(boolean inBackground) Triggers update of the spell checker dictionary index.
static void	updateSpellCheckerIndex() Triggers update of the spell checker dictionary index, which is executed in a separate thread.
static void	updateSpellCheckerIndex(boolean inBackground) Triggers update of the spell checker dictionary index.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR_IN_SUGGESTION

public static final String SEPARATOR_IN_SUGGESTION

See Also:

Constant Field Values

MAX_TERMS_PARAM

public static final String MAX_TERMS_PARAM

See Also:

Constant Field Values

SITES_PARAM

public static final String SITES_PARAM

See Also:

Constant Field Values

Constructor Detail

CompositeSpellChecker

public CompositeSpellChecker()

Spell checker with a default refresh interval of one hour.

CompositeSpellChecker

protected CompositeSpellChecker(long refreshInterval)

Method Detail

updateSpellCheckerIndex

public static void updateSpellCheckerIndex()

Triggers update of the spell checker dictionary index, which is executed in a separate thread.

updateSpellCheckerIndex

public static void updateSpellCheckerIndex(boolean inBackground)

Triggers update of the spell checker dictionary index.

Parameters:

inBackground - specifies if the update should be done in a separate thread; if false the update will be done in the main thread, blocking the return until it is finished

init

public void init(org.apache.jackrabbit.core.query.QueryHandler handler)
          throws IOException

Initializes this spell checker.

Specified by:

init in interface org.apache.jackrabbit.core.query.lucene.SpellChecker

Parameters:

handler - the query handler that created this spell checker.

Throws:

IOException - if handler is not of type SearchIndex.

check

public String check(org.apache.jackrabbit.spi.commons.query.QueryRootNode aqt)
             throws IOException

Specified by:

check in interface org.apache.jackrabbit.core.query.lucene.SpellChecker

Throws:

IOException

close

public void close()

Specified by:

close in interface org.apache.jackrabbit.core.query.lucene.SpellChecker

updateIndex

public void updateIndex()

Triggers update of the spell checker dictionary index.

updateIndex

public void updateIndex(boolean inBackground)

Triggers update of the spell checker dictionary index.

Parameters:

inBackground - specifies if the update should be done in a separate thread