org.jahia.services.search.jcr

Class JahiaJCRSearchProvider

java.lang.Object

org.jahia.services.search.jcr.JahiaJCRSearchProvider

All Implemented Interfaces:

SearchProvider, SearchProvider.SupportsSuggestion

public class JahiaJCRSearchProvider
extends Object
implements SearchProvider, SearchProvider.SupportsSuggestion

This is the default search provider used by Jahia and used the index created by Jahia's main repository, which is based on Apache Jackrabbit. The search request is also done on mounted external repositories.

For now the search criteria is converted to XPATH queries, which is despite of the deprecation still the most stable and performance means to use search in Jackrabbit.

For future versions we may change to either SQL-2 or directly the QueryObejctModel specified in JSR-283.

Author:

Benjamin Papez

Nested Class Summary

Nested classes/interfaces inherited from interface org.jahia.services.search.SearchProvider

SearchProvider.SupportsSuggestion

Constructor Summary

Constructors

Constructor and Description
JahiaJCRSearchProvider()

Method Summary

Modifier and Type	Method and Description
javax.jcr.query.Query	buildQuery(SearchCriteria criteria, JCRSessionWrapper session) Creates the Query instance by converting the provided SearchCriteria bean into XPath query.
String	getName()
TaggingService	getTaggingService()
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.
void	setName(String name)
void	setTaggingService(TaggingService taggingService)
void	setTypesToHideFromSearchResults(Set<String> typesToHideFromSearchResults)
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 maxTerms) Returns a modified suggestion for the original query based on the spell checker dictionary.
Suggestion	suggest(String originalQuery, String[] sites, RenderContext context, int maxTermsToSuggest)

Methods inherited from class java.lang.Object

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

Constructor Detail

JahiaJCRSearchProvider

public JahiaJCRSearchProvider()

Method Detail

search

public SearchResponse search(SearchCriteria criteria,
                             RenderContext context)

Description copied from interface: SearchProvider

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 interface SearchProvider

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

Description copied from interface: SearchProvider

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 interface SearchProvider

Parameters:

originalQuery - original query string

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

maxTerms - 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.

suggest

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

Description copied from interface: SearchProvider.SupportsSuggestion

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 interface SearchProvider.SupportsSuggestion

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.

suggest

public Suggestion suggest(String originalQuery,
                          String[] sites,
                          RenderContext context,
                          int maxTermsToSuggest)

buildQuery

public javax.jcr.query.Query buildQuery(SearchCriteria criteria,
                                        JCRSessionWrapper session)
                                 throws javax.jcr.query.InvalidQueryException,
                                        javax.jcr.RepositoryException

Creates the Query instance by converting the provided SearchCriteria bean into XPath query.

Parameters:

criteria - the search criteria to use for the query

session - current JCR session

Returns:

the Query instance created by converting the provided SearchCriteria bean into XPath query or null if the query cannot be created

Throws:

javax.jcr.query.InvalidQueryException

javax.jcr.RepositoryException - in case of JCR-related errors

getTaggingService

public TaggingService getTaggingService()

setTaggingService

public void setTaggingService(TaggingService taggingService)

setTypesToHideFromSearchResults

public void setTypesToHideFromSearchResults(Set<String> typesToHideFromSearchResults)

getName

public String getName()

Specified by:

getName in interface SearchProvider

setName

public void setName(String name)

isEnabled

public boolean isEnabled()

Description copied from interface: SearchProvider

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

Specified by:

isEnabled in interface SearchProvider

Returns:

true if the provider is enabled, false otherwise.