org.jahia.services.search

Class SearchService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.search.SearchService

Direct Known Subclasses:

SearchServiceImpl

public abstract class SearchService
extends JahiaService

Abstract class for the new Jahia search service. In contrast to the query-services, which allow all kind of complex queries, the search service is more simple and mainly takes care about fulltext (unstructured) search and metadata search. The search service can forward the request to different SearchProvider implementations. The default SearchProvider is based on Jahia's JCR wrapper, which uses Apache Jackrabbit as main repository, but can itself integrate multiple mounted external repositories via the Jahia Universal Content Hub. Alternatively it is possible to plug-in a search provider, which uses a crawled index. Jahia will provide an implementation based on Apache Nutch crawler and an index maintained by Apache Solr. It should also be possible to plug-in OpenSearch based search services as well as individual plug-ins to third party search engines (like Google Appliance).

Author:

Benjamin Papez

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
SearchService()

Method Summary

Modifier and Type	Method and Description
abstract 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.
abstract Suggestion	suggest(SearchCriteria originalQuery, RenderContext context, int maxTermsToSuggest) Returns a modified suggestion for the original query based on the spell checker dictionary.
abstract Suggestion	suggest(String originalQuery, RenderContext context, int maxTermsToSuggest) Deprecated. use suggest(SearchCriteria originalQuery, RenderContext context, int maxTermsToSuggest)

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchService

public SearchService()

Method Detail

search

public abstract 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

public abstract 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 be suggested

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.

suggest

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

Deprecated. use 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 query string

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

maxTermsToSuggest - the maximum number of terms to be suggested

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.