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

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

All Implemented Interfaces:

WordSuggester

public class LuceneWordSuggester
extends Object
implements WordSuggester

A service that is responsible for providing search suggestions determined from searching a lucene based index. Also see javadoc for WordSuggester.

Field Summary

static org.apache.log4j.Logger

log Deprecated.

Constructor Summary

LuceneWordSuggester(com.atlassian.bonnie.ILuceneConnection didYouMeanLuceneConnection, List<SuggestionsProvider> suggestionsProviders, SuggestionFrequencyProvider suggestionFrequencyProvider)

Method Summary

boolean	isMemberOfVocabulary(String word) The vocabulary is composed of words sourced from Confluence content and the bundled dictionary.
String	suggest(String word) Provides a suggestion for the specified word.
String	suggest(String word, boolean checkSuggestionFrequency) Provides a suggestion for the specified word, and the option to enable/disable the searching of a word that appears more often in Confluence content.
List<String>	suggest(String word, int numSuggestions, boolean checkSuggestionFrequency) Provides a suggestion for the specified word, providing the option to enable/disable ranking suggestions against the frequency in which they occur in Confluence content.
List<String>	suggestSimilar(String word, int numSuggestions, boolean enableSuggestionFreqRanking)

Methods inherited from class java.lang.Object

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

Field Detail

log

@Deprecated
public static final org.apache.log4j.Logger log

Deprecated.

Constructor Detail

LuceneWordSuggester

public LuceneWordSuggester(com.atlassian.bonnie.ILuceneConnection didYouMeanLuceneConnection,
                           List<SuggestionsProvider> suggestionsProviders,
                           SuggestionFrequencyProvider suggestionFrequencyProvider)

Method Detail

suggest

public String suggest(String word)

Description copied from interface: WordSuggester

Provides a suggestion for the specified word. The suggestion can be either a word with the correct spelling or one that appears more often in the search index.

Returns null, if specified word length exceeds DidYouMean.Constants.MAX_INPUT_WORD_LENGTH

Specified by:

suggest in interface WordSuggester

Parameters:

word - a word to get a spelling suggestion on

Returns:

a suggestion for the specified word or null if no suggestion could be found

suggest

public String suggest(String word,
                      boolean checkSuggestionFrequency)

Description copied from interface: WordSuggester

Provides a suggestion for the specified word, and the option to enable/disable the searching of a word that appears more often in Confluence content. Only the case of the first letter of the specified word will be preseved in the suggestion.

If frequency ranking is disabled and the word already belongs to the vocabulary (that is, WordSuggester.isMemberOfVocabulary(String) is true), null is returned. This simply means no suggestions are relevant for existing vocabulary words.

Returns null, if specified word length exceeds DidYouMean.Constants.MAX_INPUT_WORD_LENGTH

Specified by:

suggest in interface WordSuggester

Parameters:

word - a word

checkSuggestionFrequency - whether or not to rank suggestions by the frequency in which they appear in Confluence content.

Returns:

a suggestion for the specified word or null if no suggestion could be found

suggest

public List<String> suggest(String word,
                            int numSuggestions,
                            boolean checkSuggestionFrequency)

Description copied from interface: WordSuggester

Provides a suggestion for the specified word, providing the option to enable/disable ranking suggestions against the frequency in which they occur in Confluence content. Only the case of the first letter of the specified word will be preseved in the suggestion.

Specified by:

suggest in interface WordSuggester

Parameters:

word - a word

numSuggestions - a list of ranked suggestions

checkSuggestionFrequency - whether or not to consider the frequency of a suggestion in COnfluence's index for ranking purposes.

Returns:

a ranked list of suggestions for the specified word.

isMemberOfVocabulary

public boolean isMemberOfVocabulary(String word)

Description copied from interface: WordSuggester

The vocabulary is composed of words sourced from Confluence content and the bundled dictionary.

Specified by:

isMemberOfVocabulary in interface WordSuggester

Parameters:

word - a word

Returns:

true if the word is part of the vocabulary, false otherwise.

suggestSimilar

public List<String> suggestSimilar(String word,
                                   int numSuggestions,
                                   boolean enableSuggestionFreqRanking)