com.atlassian.confluence.search.didyoumean
Class QuerySuggester

java.lang.Object
  com.atlassian.confluence.search.didyoumean.QuerySuggester

public class QuerySuggester
extends Object

Class that provides suggestions on a query where one or more words are replaced with either:

• a spelling correction
• or a word that occurs more frequently (this is only provided for single term queries at the present time.

Nested Class Summary

static class	QuerySuggester.QuerySuggestion Class that represents a query suggestion
static interface	QuerySuggester.QueryTermDecorator Callback interface to allow custom decoration of individual terms inside a query suggestion

Field Summary

static QuerySuggester.QueryTermDecorator

DEFAULT_DECORATOR Default decorator that does not apply any decoration

Constructor Summary

QuerySuggester(WordSuggester wordSuggester)

Method Summary

QuerySuggester.QuerySuggestion	getSuggestion(String query) Returns a suggestion for the specified query if suggestions exist.
QuerySuggester.QuerySuggestion	getSuggestion(String query, QuerySuggester.QueryTermDecorator queryTermDecorator) Returns a decorated suggestion for the specified query if suggestions exist.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DECORATOR

public static final QuerySuggester.QueryTermDecorator DEFAULT_DECORATOR

Default decorator that does not apply any decoration

Constructor Detail

QuerySuggester

public QuerySuggester(WordSuggester wordSuggester)

Method Detail

getSuggestion

public QuerySuggester.QuerySuggestion getSuggestion(String query)

Returns a suggestion for the specified query if suggestions exist.

Parameters:

query - the query

Returns:

a suggestion for the specified query if suggestions exist, null otherwise.

Throws:

IllegalArgumentException - if query is null.

getSuggestion

public QuerySuggester.QuerySuggestion getSuggestion(String query,
                                                    QuerySuggester.QueryTermDecorator queryTermDecorator)

Returns a decorated suggestion for the specified query if suggestions exist.

Parameters:

queryTermDecorator - callback to use if you want to decorate a suggestion for a query term before its appended

Returns:

a suggestion for the current query if suggestions exist, null otherwise

Throws:

IllegalArgumentException - if query is null or queryTermDecorator is null