|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WordSuggester
Class that provides word suggestions. The suggestion can be either a word with the correct spelling or one that appears more often in the search index. It is important to note that the spelling of a suggestion may not necessarily be correct, as this suggester serves words that are collected from Confluence content (which can contain errors).
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 suggestions,
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. |
Method Detail |
---|
String suggest(String word)
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
word
- a word to get a spelling suggestion on
IndexIOException
- if there was an error reading the
index while processing this requestString 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. 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, 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
word
- a wordcheckSuggestionFrequency
- whether or not to rank suggestions by the
frequency in which they appear in
Confluence content.
IndexIOException
- if there was an error reading the
index while processing this requestList<String> suggest(String word, int suggestions, 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. Only the case of the first letter of the specified word will be preseved in the suggestion.
word
- a wordsuggestions
- a list of ranked suggestionscheckSuggestionFrequency
- whether or not to consider the frequency of a suggestion
in COnfluence's index for ranking purposes.
IndexIOException
- if there was an error reading the
index while processing this requestboolean isMemberOfVocabulary(String word)
word
- a word
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |