org.jahia.services.search

Interface SearchProvider.SupportsSuggestion

All Known Implementing Classes:

JahiaJCRSearchProvider

Enclosing interface:

SearchProvider

public static interface SearchProvider.SupportsSuggestion

Method Summary

Modifier and Type	Method and Description
Suggestion	suggest(SearchCriteria originalQuery, RenderContext context, int maxTermsToSuggest) Returns a modified suggestion for the original query based on the spell checker dictionary.

Method Detail

suggest

Suggestion suggest(SearchCriteria originalQuery,
                   RenderContext context,
                   int maxTermsToSuggest)

Returns a modified suggestion for the original query based on the spell checker dictionary. If the spelling is correct or the spell checker does not know how to correct the query or the provider does not support this feature null is returned.

Parameters:

originalQuery - original search criteria

context - context object, containing information about current site, workspace, locale etc.

maxTermsToSuggest - the maximum number of terms to suggest

Returns:

a modified suggestion for the original query based on the spell checker dictionary. If the spelling is correct or the spell checker does not know how to correct the query null is returned.