org.jahia.services.search

Class SearchServiceImpl

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.search.SearchService

org.jahia.services.search.SearchServiceImpl

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

public class SearchServiceImpl
extends SearchService
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

Default implementation of the SearchService.

Author:

Benjamin Papez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchServiceImpl.SearchSettingsChangedEvent This event is fired when the changes in search server settings are detected (notification from other cluster nodes).

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
static void	executeURLModificationRules(Hit<?> searchHit, RenderContext context) Execute rules on a single search hit object.
static void	executeURLModificationRules(List<? extends Hit> searchHits, RenderContext context) Execute rules on the list of hit objects.
List<String>	getAvailableProviders() Return the list of available provider names
SearchProvider	getCurrentProvider() Returns an instance of the search provider for handling query requests.
protected SearchProvider	getDefaultSearchProvider()
static SearchServiceImpl	getInstance()
protected SearchProvider	getProvider(String name) Returns an instance of the search provider for handling query requests.
SearchSettings	getSettings()
protected void	load()
void	onApplicationEvent(org.springframework.context.ApplicationEvent evt)
void	registerSearchProvider(SearchProvider searchProvider) Register the given search provider in the available search providers
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.
void	setDefaultSearchProvider(SearchProvider defaultSearchProvider)
void	start()
void	stop()
void	store(SearchSettings cfg)
protected void	store(SearchSettings cfg, JCRSessionWrapper session)
Suggestion	suggest(SearchCriteria originalQuery, RenderContext context, int maxTermsToSuggest) Returns a modified suggestion for the original query based on the spell checker dictionary.
Suggestion	suggest(String originalQuery, RenderContext context, int maxTermsToSuggest) Returns a modified suggestion for the original query based on the spell checker dictionary.
void	unregisterSearchProvider(SearchProvider searchProvider) Unregister the given search provider in the available search providers

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Method Detail

getSettings

public SearchSettings getSettings()

getInstance

public static SearchServiceImpl getInstance()

search

public SearchResponse search(SearchCriteria criteria,
                             RenderContext context)

Description copied from class: SearchService

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.

Specified by:

search in class SearchService

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

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Specified by:

stop in class JahiaService

Throws:

JahiaException

suggest

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

Description copied from class: SearchService

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.

Specified by:

suggest in class SearchService

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 Suggestion suggest(String originalQuery,
                          RenderContext context,
                          int maxTermsToSuggest)

Description copied from class: SearchService

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.

Specified by:

suggest in class SearchService

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.

executeURLModificationRules

public static void executeURLModificationRules(List<? extends Hit> searchHits,
                                               RenderContext context)

Execute rules on the list of hit objects.

Parameters:

searchHits, - list of JCRNodeHit objects

context, - current rendering context

executeURLModificationRules

public static void executeURLModificationRules(Hit<?> searchHit,
                                               RenderContext context)

Execute rules on a single search hit object.

Parameters:

searchHit, - JCRNodeHit object

context, - current rendering context

getCurrentProvider

public SearchProvider getCurrentProvider()

Returns an instance of the search provider for handling query requests.

Returns:

an instance of the search provider for handling query requests

getProvider

protected SearchProvider getProvider(String name)

Returns an instance of the search provider for handling query requests.

Returns:

an instance of the search provider for handling query requests

registerSearchProvider

public void registerSearchProvider(SearchProvider searchProvider)
                            throws InvalidSearchProviderException

Register the given search provider in the available search providers

Parameters:

searchProvider -

Throws:

InvalidSearchProviderException

unregisterSearchProvider

public void unregisterSearchProvider(SearchProvider searchProvider)
                              throws InvalidSearchProviderException

Unregister the given search provider in the available search providers

Parameters:

searchProvider -

Throws:

InvalidSearchProviderException

getAvailableProviders

public List<String> getAvailableProviders()

Return the list of available provider names

Returns:

load

protected void load()

store

public void store(SearchSettings cfg)

store

protected void store(SearchSettings cfg,
                     JCRSessionWrapper session)
              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent evt)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setDefaultSearchProvider

public void setDefaultSearchProvider(SearchProvider defaultSearchProvider)

getDefaultSearchProvider

protected SearchProvider getDefaultSearchProvider()