org.jahia.services.search

Interface SearchProvider

All Known Implementing Classes:

JahiaJCRSearchProvider

public interface SearchProvider

Interface for different provider implementations used by the SearchService.

Author:

Benjamin Papez

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SearchProvider.SupportsSuggestion

Method Summary

Modifier and Type	Method and Description
String	getName()
boolean	isEnabled() Checks whether this provider is enabled.
SearchResponse	search(SearchCriteria criteria, RenderContext context) Performs a search using the SearchCriteria object, which is created with using the Jahia Search Tags or can also be created in Java classes by using the SearchCriteriaFactory.
Suggestion	suggest(String originalQuery, RenderContext context, int maxTermsToSuggest) Deprecated. Use SupportsSuggestion interface instead

Method Detail

search

SearchResponse search(SearchCriteria criteria,
                      RenderContext context)

Performs a search using the SearchCriteria object, which is created with using the Jahia Search Tags or can also be created in Java classes by using the SearchCriteriaFactory.

Parameters:

criteria - the passed SearchCriteria object, which includes all search criteria

context - context object, containing information about current user, locale etc.

Returns:

SearchResponse object with the list of hits matching the criteria

suggest

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

Deprecated. Use SupportsSuggestion interface instead

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 query string

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.

getName

String getName()

isEnabled

boolean isEnabled()

Checks whether this provider is enabled. This can be used to perform licensing checks for example.

Returns:

true if the provider is enabled, false otherwise.